Skip to content

Commit

Permalink
generator published at npmjs site.
Browse files Browse the repository at this point in the history
- version updating to 1.1.1
- added extra readme file for npmjs site.
- updated docs.
- updated package file.
  • Loading branch information
OurCodeBase committed Sep 21, 2024
1 parent bea7747 commit 51733af
Show file tree
Hide file tree
Showing 4 changed files with 89 additions and 13 deletions.
5 changes: 1 addition & 4 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,2 @@
/README.md
/docs
/.github
/docs/.vitepress
/package-lock.json
/docs/.vitepress/dist
80 changes: 80 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Gen3 Express
A gen3 tool to generate express app boilerplate.

## 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/)

## 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.

### 1. node package extecutor
This method is highly recommended to generate an express app.
```bash
npx gen3-express my-app
```

### 2. node package manager
Generation of an express app is not recommended through npm.
```bash
npm install -g gen3-express
```
```bash
gen3-express my-app
```

## Documentation
To install all dev dependencies goto the folder and hit `npm install` command.
```bash
cd my-app
npm install
```
To start a dev server to preview page use `server` word.
- Keep in mind that
- The below command does not include EJS live reloading.

```bash
npm run server
```
To start a dev server to live preview EJS page use `sync` word.
```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.
```bash
npm run server & npm run sync
```

## File Cases
To know about the product or project structure read about files included in this code block.

```bash
.
├── app.js # this core file handles express functions and server.
├── 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.
```

## Roadmap

- Custom name in `package.json` file ✅
- Excellent terminal user interface ✅
- Prompt `package.json` file's details from user. ⏩
- Post this project to npmjs website. ✅
- Custom local template feature ⏩

## Authors
- [@OurCodeBase](https://www.github.com/OurCodeBase)

## Contributing
Contributions are always welcome!
8 changes: 4 additions & 4 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ You can install and generate an express app using this tool in two approaches. H
### 1. node package extecutor
This method is highly recommended to generate an express app.
```bash
npx https://www.github.com/OurCodeBase/gen3-express my-app
npx gen3-express my-app
```

### 2. node package manager
Generation of an express app is not recommended through npm.
```bash
npm install -g https://www.github.com/OurCodeBase/gen3-express.git
npm install -g gen3-express
```
```bash
gen3-express my-app
Expand Down Expand Up @@ -75,11 +75,11 @@ To know about the product or project structure read about files included in this
- Custom name in `package.json` file ✅
- Excellent terminal user interface ✅
- Prompt `package.json` file's details from user. ⏩
- Post this project to npmjs website.
- Post this project to npmjs website.
- Custom local template feature ⏩

## Authors
- [@OurCodeBase](https://www.github.com/OurCodeBase)

## Contributing
Contributions are always welcome!
Contributions are always welcome!
9 changes: 4 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"name": "gen3-express",
"version": "1.0.0",
"description": "A gen3 tool to generate get started express app",
"main": "index.js",
"name": "@aspandapo/gen3-express",
"version": "1.1.1",
"description": "A gen3 tool to generate express app boilerplate.",
"bin": {
"gen3-express": "./bin/gen3-express.js"
},
Expand All @@ -26,7 +25,7 @@
"bugs": {
"url": "https://github.com/OurCodeBase/gen3-express/issues"
},
"homepage": "https://github.com/OurCodeBase/gen3-express#readme",
"homepage": "https://ourcodebase.github.io/gen3-express",
"dependencies": {
"commander": "^12.1.0",
"fs-extra": "^11.2.0",
Expand Down

0 comments on commit 51733af

Please sign in to comment.