From bea77473e0b7bf563cf93e4794a850ac6a5e69f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?h=CE=B1rsh=20v=CE=B1ir=CE=B1gi?= Date: Sat, 21 Sep 2024 18:15:26 +0530 Subject: [PATCH] readme file merged in docs folder. --- docs/documentation.md | 85 ------------------------------------- docs/index.md | 4 +- readme.md => docs/readme.md | 0 3 files changed, 2 insertions(+), 87 deletions(-) delete mode 100644 docs/documentation.md rename readme.md => docs/readme.md (100%) diff --git a/docs/documentation.md b/docs/documentation.md deleted file mode 100644 index 83e496a..0000000 --- a/docs/documentation.md +++ /dev/null @@ -1,85 +0,0 @@ -# Gen3 Express -A gen3 tool to generate express app boilerplate. - -## Changelogs 1.1.0 -tui has been implemented to gen3-express. -- used signale to implement tui. -- changes many things in gen3-express file. - -## 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 https://www.github.com/OurCodeBase/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 -``` -```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! \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index fa0f3e1..9c0ab7c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ hero: actions: - theme: brand text: Get Started - link: /documentation + link: /readme - theme: alt text: View on GitHub link: https://github.com/OurCodeBase/gen3-express @@ -32,4 +32,4 @@ features: - icon: 🥙 title: NPX Usable details: You don't neet to install a separate tool to generate express apps. You can just simply use npx to fetch files and dependencies temporarily. ---- \ No newline at end of file +--- diff --git a/readme.md b/docs/readme.md similarity index 100% rename from readme.md rename to docs/readme.md