Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.26 KB

Getting-started-guide.md

File metadata and controls

40 lines (26 loc) · 1.26 KB
Raw

Getting Started Guide

Use this repository as template repository and find (search in folder) [TODO in root folder then replace them as their following instructions. [TODO: remove this line]

Prerequisite [TODO: update following list]

  1. Node installed on your machine.
  2. MongoDB URI to connect with Database.
  3. Check extensions.json file in .vscode directory some of these extensions are required for maintain code consistency.

Setup [TODO: update following list]

  1. Fork the Template-Repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create .env file and fill environment variables as following written in .env.example file.
  4. Run npm i to install the dependencies and set up the project.

Development [TODO: update following instructions]

To run project on your local machine, run:

npm run dev

Building [TODO: update following instructions]

To generate a production-ready version of your code, run:

npm run build

To test production-ready version of your code, run:

npm start

[TODO: update LICENSE file according your project then remove this line]