Skip to content

Commit

Permalink
docs updated to v1.1.4 version.
Browse files Browse the repository at this point in the history
  • Loading branch information
OurCodeBase committed Oct 24, 2024
1 parent 82dd4bf commit cbbfb57
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 33 deletions.
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
A gen3 tool to generate express app.

## Acknowledgements
You need to know atleast basics about these things.
You need to know atleast basics of these technologies.
- [NodeJS](https://nodejs.org/docs/latest/api/)
- [ExpressJS](https://expressjs.com/en/5x/api.html)
- [Embedded JS](https://ejs.co/)

## Installation
You can install and generate an express app using this tool in two approaches. Here I'm generating an app with name `my-app`, you can name to it anything you like.
You can generate an express app using this tool in two approaches. Here I'm generating an app with name `my-app`, you can name to it anything you like.

### 1. node package extecutor
This method is highly recommended to generate an express app.
Expand All @@ -26,21 +26,21 @@ gen3-express my-app
```

## Tailwind CSS
To get tailwind css boilerplate, you can add `-t` or `--tailwindcss` switches or flags while generating a site.
To get tailwind css boilerplate, you can add `-t` or `--tailwindcss` switch or flag while generating a site.
```bash
npx gen3-express my-app --tailwindcss
```

### Usage
To add tailwindcss to your `EJS` page, use `css/tailwind.css` into a `link` tag.
To add tailwindcss to your frontend page, use `css/tailwind.css` into a `link` tag.
```html
<link href="css/tailwind.css" rel="stylesheet">
```
Because of `tailwind` updates css file according your needs, We need to run a `tailwind` sever with command below.
We have to run a `tailwind` sever with the below command, because `tailwindcss` regularly update css file according to your needs.
```bash
npm run tailwind
```
- If you choosed tailwind css boilerplate then this server will run with `dev` keyword server.
- You can run frontend, backend and tailwind servers parallelly using `dev` keyword.

## Documentation
To install all dependencies goto the folder and execute `npm install` command.
Expand All @@ -49,22 +49,19 @@ cd my-app
npm install
```
To start a dev server to preview page use `server` keyword.
- Keep in mind that the below command does not provide live reloading in `EJS` and `public` files.
- The below command does also provide live reloading in frontend and `public` files.

```bash
npm run server
```
To get live reloading in `EJS` and `public` folder, create another server with `sync` keyword.
```bash
npm run sync
```
If you want to run all these servers together then you should to use this below command, this command will provide you hot reloadings in every place.
If you want to run all servers together (especially tailwindcss) then you should to use the below command, this command provides multiple servers parallelly.
```bash
npm run dev
```

## File Tree
To know about the project structure read about files included in this code block.
- In case of tailwindcss, the boilerplate contains additional files like `tailwind.config.js` for tailwindcss configs.

```yml
.
Expand All @@ -75,7 +72,7 @@ To know about the project structure read about files included in this code block
│   │   └── style.css
│   └── fonts
│   └── sans.woff
├── sync.js # configuration for hot reloadings in ejs and static files.
├── nodemon.json # configs for hot reloadings in frontend and backend.
├── utils
│   └── netface.js # contains functions to show available ipv4 addresses.
└── views
Expand Down
9 changes: 8 additions & 1 deletion docs/changelogs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Changelogs
You can check most latest changlogs at [commits](https://github.com/OurCodeBase/gen3-express/commits/main/) or [versions](https://github.com/OurCodeBase/gen3-express/releases) sections in github.

## 1.1.3 is released
## Changelogs 1.1.4
Source code is now more minimal.
- docs has been updated.
- commands have been updated.
- hot reloading servers are merged in one server.
- parallel server runner is now highly optimised, and efficient.

## Changelogs 1.1.3
tailwind css support is added.
- a new file `tailwind.config.js` is created for tailwind users.
- multiple server runs shifted to single `dev` keyword command.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ features:
title: Cross Platform
details: You can use this tool on any platform like Linux, MacOS, Windows (WSL) and also on Android (Termux).
- icon: 🍃
title: Tailwind CSS (new)
title: Tailwind CSS
details: You can include tailwind css to your site with one switch while generate.
---
33 changes: 15 additions & 18 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@
A gen3 tool to generate express app.

> [!IMPORTANT]
> ### 1.1.3 is released
> tailwind css support is added.
> - a new file `tailwind.config.js` is created for tailwind users.
> - multiple server runs shifted to single `dev` keyword command.
> - all dependencies has been updated.
> ### 1.1.4 is released
> - docs has been updated.
> - commands have been updated.
> - hot reloading servers are merged in one server.
> - parallel server runner is now highly optimised, and efficient.
## Acknowledgements
You need to know atleast basics about these things.
You need to know atleast basics of these technologies.
- [NodeJS](https://nodejs.org/docs/latest/api/)
- [ExpressJS](https://expressjs.com/en/5x/api.html)
- [Embedded JS](https://ejs.co/)

## Installation
You can install and generate an express app using this tool in two approaches. Here I'm generating an app with name `my-app`, you can name to it anything you like.
You can generate an express app using this tool in two approaches. Here I'm generating an app with name `my-app`, you can name to it anything you like.

### 1. node package extecutor
This method is highly recommended to generate an express app.
Expand All @@ -33,21 +33,21 @@ gen3-express my-app
```

## Tailwind CSS
To get tailwind css boilerplate, you can add `-t` or `--tailwindcss` switches or flags while generating a site.
To get tailwind css boilerplate, you can add `-t` or `--tailwindcss` switch or flag while generating a site.
```bash
npx gen3-express my-app --tailwindcss
```

### Usage
To add tailwindcss to your `EJS` page, use `css/tailwind.css` into a `link` tag.
To add tailwindcss to your frontend page, use `css/tailwind.css` into a `link` tag.
```html
<link href="css/tailwind.css" rel="stylesheet">
```
Because of `tailwind` updates css file according your needs, We need to run a `tailwind` sever with command below.
We have to run a `tailwind` sever with the below command, because `tailwindcss` regularly update css file according to your needs.
```bash
npm run tailwind
```
- If you choosed tailwind css boilerplate then this server will run with `dev` keyword server.
- You can run frontend, backend and tailwind servers parallelly using `dev` keyword.

## Documentation
To install all dependencies goto the folder and execute `npm install` command.
Expand All @@ -56,22 +56,19 @@ cd my-app
npm install
```
To start a dev server to preview page use `server` keyword.
- Keep in mind that the below command does not provide live reloading in `EJS` and `public` files.
- The below command does also provide live reloading in frontend and `public` files.

```bash
npm run server
```
To get live reloading in `EJS` and `public` folder, create another server with `sync` keyword.
```bash
npm run sync
```
If you want to run all these servers together then you should to use this below command, this command will provide you hot reloadings in every place.
If you want to run all servers together (especially tailwindcss) then you should to use the below command, this command provides multiple servers parallelly.
```bash
npm run dev
```

## File Tree
To know about the project structure read about files included in this code block.
- In case of tailwindcss, the boilerplate contains additional files like `tailwind.config.js` for tailwindcss configs.

```yml
.
Expand All @@ -82,7 +79,7 @@ To know about the project structure read about files included in this code block
│   │   └── style.css
│   └── fonts
│   └── sans.woff
├── sync.js # configuration for hot reloadings in ejs and static files.
├── nodemon.json # configs for hot reloadings in frontend and backend.
├── utils
│   └── netface.js # contains functions to show available ipv4 addresses.
└── views
Expand Down

0 comments on commit cbbfb57

Please sign in to comment.