Skip to content

Commit

Permalink
readme docs has been updated for version v1.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
OurCodeBase authored Sep 16, 2024
1 parent 012ca77 commit da62869
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
# Gen3 Express
A gen3 tool to generate get started express app.
## Changelogs 1.0.1

> [!TIP]
> nets module has been shifted from `/nets.js` to the utils folder `/utils/nets.js`.
> docs have also been updated.
## Acknowledgements
You need to know atleast basics about these things.
- [NodeJS](https://nodejs.org/docs/latest/api/)
- [ExpressJS](https://expressjs.com/en/5x/api.html)
- [Embedded JS](https://ejs.co/)

## Features

- Minimal and Useful πŸ’«
- JS Hot Reloadings πŸš€
- EJS and Static Hot Reloadings πŸ“œ
- Cross Platform βš”
- NPX (no need to install extra stuff) πŸ₯™
## 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.

Expand Down Expand Up @@ -51,7 +47,7 @@ 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.
```bash
npm run server & npm run server
npm run server & npm run sync
```

## File Cases
Expand All @@ -60,13 +56,14 @@ To know about the product or project structure read about files included in this
```bash
.
β”œβ”€β”€ app.js # this core file handles express functions and server.
β”œβ”€β”€ nets.js # this file provides functions to display available ip addresses on your network.
β”œβ”€β”€ package.json # package file handles dependencies, and details about the product.
β”œβ”€β”€ public # this folder contains public data like fonts, css and multimedia.
β”‚Β Β  β”œβ”€β”€ fonts
β”‚Β Β  β”‚Β Β  └── sans.woff
β”‚Β Β  └── style.css
β”œβ”€β”€ sync.js # this file is needed to configure hot reloadings in ejs and static files.
β”œβ”€β”€ utils
β”‚Β Β  └── nets.js # this file provides functions to display available ip addresses on your network.
└── views # this folder contains ejs or html files to render contents.
└── home.ejs # this file is the landing page of the product.
```
Expand Down

0 comments on commit da62869

Please sign in to comment.