Skip to content

Commit cd40517

Browse files
committed
have to add readme.md file for npmjs.
1 parent 8edef35 commit cd40517

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

README.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Gen3 Express
2+
A gen3 tool to generate express app boilerplate.
3+
4+
## Acknowledgements
5+
You need to know atleast basics about these things.
6+
- [NodeJS](https://nodejs.org/docs/latest/api/)
7+
- [ExpressJS](https://expressjs.com/en/5x/api.html)
8+
- [Embedded JS](https://ejs.co/)
9+
10+
## Installation
11+
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.
12+
13+
### 1. node package extecutor
14+
This method is highly recommended to generate an express app.
15+
```bash
16+
npx gen3-express my-app
17+
```
18+
19+
### 2. node package manager
20+
Generation of an express app is not recommended through npm.
21+
```bash
22+
npm install -g gen3-express
23+
```
24+
```bash
25+
gen3-express my-app
26+
```
27+
28+
## Documentation
29+
To install all dev dependencies goto the folder and hit `npm install` command.
30+
```bash
31+
cd my-app
32+
npm install
33+
```
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.
37+
38+
```bash
39+
npm run server
40+
```
41+
To start a dev server to live preview EJS page use `sync` word.
42+
```bash
43+
npm run sync
44+
```
45+
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.
46+
```bash
47+
npm run server & npm run sync
48+
```
49+
50+
## File Cases
51+
To know about the product or project structure read about files included in this code block.
52+
53+
```bash
54+
.
55+
├── app.js
56+
├── package.json
57+
├── public
58+
│   ├── css
59+
│   │   └── style.css
60+
│   └── fonts
61+
│   └── sans.woff
62+
├── sync.js # configuration for hot reloadings in ejs and static files.
63+
├── utils
64+
│   └── netface.js # contains functions to show available ipv4 addresses.
65+
└── views
66+
└── home.ejs
67+
```
68+
69+
## Roadmap
70+
71+
- Custom name in `package.json` file ✅
72+
- Excellent terminal user interface ✅
73+
- Prompt `package.json` file's details from user. ⏩
74+
- Post this project to npmjs website. ✅
75+
- Custom local template feature ⏩
76+
77+
## Authors
78+
- [@OurCodeBase](https://www.github.com/OurCodeBase)
79+
80+
## Contributing
81+
Contributions are always welcome!

0 commit comments

Comments
 (0)