Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 885 Bytes

Getting-started-guide.md

File metadata and controls

36 lines (24 loc) · 885 Bytes
Raw

Getting Started Guide

Prerequisite

  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

  1. Fork the Urlbit 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

To run project on your local machine, run:

npm run dev

Building

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

npm run build

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

npm start