Skip to content

Commit 5b6e352

Browse files
committed
shifting to v1.1.3 version of code.
- docs updated - package version updated - readme updated
1 parent ed0e519 commit 5b6e352

File tree

5 files changed

+73
-30
lines changed

5 files changed

+73
-30
lines changed

README.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Gen3 Express
2-
A gen3 tool to generate express app boilerplate.
2+
A gen3 tool to generate express app.
33

44
## Acknowledgements
55
You need to know atleast basics about these things.
@@ -25,32 +25,48 @@ npm install -g gen3-express
2525
gen3-express my-app
2626
```
2727

28+
## Tailwind CSS
29+
To get tailwind css boilerplate, you can add `-t` or `--tailwindcss` switches or flags while generating a site.
30+
```bash
31+
npx gen3-express my-app --tailwindcss
32+
```
33+
34+
### Usage
35+
To add tailwindcss to your `EJS` page, use `css/tailwind.css` into a `link` tag.
36+
```html
37+
<link href="css/tailwind.css" rel="stylesheet">
38+
```
39+
Because of `tailwind` updates css file according your needs, We need to run a `tailwind` sever with command below.
40+
```bash
41+
npm run tailwind
42+
```
43+
- If you choosed tailwind css boilerplate then this server will run with `dev` keyword server.
44+
2845
## Documentation
29-
To install all dev dependencies goto the folder and hit `npm install` command.
46+
To install all dependencies goto the folder and execute `npm install` command.
3047
```bash
3148
cd my-app
3249
npm install
3350
```
34-
To start a dev server to preview page use `server` word.
35-
- Keep in mind that
36-
- The below command does not include EJS live reloading.
51+
To start a dev server to preview page use `server` keyword.
52+
- Keep in mind that the below command does not provide live reloading in `EJS` and `public` files.
3753

3854
```bash
3955
npm run server
4056
```
41-
To start a dev server to live preview EJS page use `sync` word.
57+
To get live reloading in `EJS` and `public` folder, create another server with `sync` keyword.
4258
```bash
4359
npm run sync
4460
```
4561
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.
4662
```bash
47-
npm run server & npm run sync
63+
npm run dev
4864
```
4965

50-
## File Cases
51-
To know about the product or project structure read about files included in this code block.
66+
## File Tree
67+
To know about the project structure read about files included in this code block.
5268

53-
```bash
69+
```yml
5470
.
5571
├── app.js
5672
├── package.json
@@ -70,8 +86,10 @@ To know about the product or project structure read about files included in this
7086

7187
- Custom name in `package.json` file ✅
7288
- Excellent terminal user interface ✅
73-
- Prompt `package.json` file's details from user. ⏩
7489
- Post this project to npmjs website. ✅
90+
- Add Tailwind CSS support. ✅
91+
- Use a lightweight server for EJS live reloading. ⏩
92+
- Prompt `package.json` file's details from user. ⏩
7593
- Custom local template feature ⏩
7694

7795
## Authors

docs/changelogs.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Changelogs
22
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.
33

4+
## 1.1.3 is released
5+
tailwind css support is added.
6+
- a new file `tailwind.config.js` is created for tailwind users.
7+
- multiple server runs shifted to single `dev` keyword command.
8+
- all dependencies has been updated.
9+
410
## Changelogs 1.1.2
511
boilerplate has been optimised, enhanced and documented.
612
- `style.css` file is shifted to `public/style.css`

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,7 @@ features:
2929
- icon:
3030
title: Cross Platform
3131
details: You can use this tool on any platform like Linux, MacOS, Windows (WSL) and also on Android (Termux).
32+
- icon: 🍃
33+
title: Tailwind CSS (new)
34+
details: You can include tailwind css to your site with one switch while generate.
3235
---

docs/readme.md

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
# Gen3 Express
2-
A gen3 tool to generate express app boilerplate.
2+
A gen3 tool to generate express app.
33

44
> [!IMPORTANT]
5-
> ### 1.1.2 is released
6-
> boilerplate has been optimised, enhanced and documented.
7-
> - `style.css` file is shifted to `public/style.css`
8-
> - `nets` file is shifted to `netface`
9-
> - github `readme` file is shifted to `docs` folder.
10-
> - `.gitignore` has been added.
11-
5+
> ### 1.1.3 is released
6+
> tailwind css support is added.
7+
> - a new file `tailwind.config.js` is created for tailwind users.
8+
> - multiple server runs shifted to single `dev` keyword command.
9+
> - all dependencies has been updated.
1210
1311
## Acknowledgements
1412
You need to know atleast basics about these things.
@@ -34,32 +32,48 @@ npm install -g gen3-express
3432
gen3-express my-app
3533
```
3634

35+
## Tailwind CSS
36+
To get tailwind css boilerplate, you can add `-t` or `--tailwindcss` switches or flags while generating a site.
37+
```bash
38+
npx gen3-express my-app --tailwindcss
39+
```
40+
41+
### Usage
42+
To add tailwindcss to your `EJS` page, use `css/tailwind.css` into a `link` tag.
43+
```html
44+
<link href="css/tailwind.css" rel="stylesheet">
45+
```
46+
Because of `tailwind` updates css file according your needs, We need to run a `tailwind` sever with command below.
47+
```bash
48+
npm run tailwind
49+
```
50+
- If you choosed tailwind css boilerplate then this server will run with `dev` keyword server.
51+
3752
## Documentation
38-
To install all dev dependencies goto the folder and hit `npm install` command.
53+
To install all dependencies goto the folder and execute `npm install` command.
3954
```bash
4055
cd my-app
4156
npm install
4257
```
43-
To start a dev server to preview page use `server` word.
44-
- Keep in mind that
45-
- The below command does not include EJS live reloading.
58+
To start a dev server to preview page use `server` keyword.
59+
- Keep in mind that the below command does not provide live reloading in `EJS` and `public` files.
4660

4761
```bash
4862
npm run server
4963
```
50-
To start a dev server to live preview EJS page use `sync` word.
64+
To get live reloading in `EJS` and `public` folder, create another server with `sync` keyword.
5165
```bash
5266
npm run sync
5367
```
5468
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.
5569
```bash
56-
npm run server & npm run sync
70+
npm run dev
5771
```
5872

59-
## File Cases
60-
To know about the product or project structure read about files included in this code block.
73+
## File Tree
74+
To know about the project structure read about files included in this code block.
6175

62-
```bash
76+
```yml
6377
.
6478
├── app.js
6579
├── package.json
@@ -79,8 +93,10 @@ To know about the product or project structure read about files included in this
7993

8094
- Custom name in `package.json` file ✅
8195
- Excellent terminal user interface ✅
82-
- Prompt `package.json` file's details from user. ⏩
8396
- Post this project to npmjs website. ✅
97+
- Add Tailwind CSS support. ✅
98+
- Use a lightweight server for EJS live reloading. ⏩
99+
- Prompt `package.json` file's details from user. ⏩
84100
- Custom local template feature ⏩
85101

86102
## Authors

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "gen3-express",
3-
"version": "1.1.2",
3+
"version": "1.1.3",
44
"description": "A gen3 tool to generate express app boilerplate.",
55
"bin": {
66
"gen3-express": "./bin/gen3-express.js"

0 commit comments

Comments
 (0)