Skip to content

enayetsyl/gardenia-be

Repository files navigation

Express Backend Boilerplate

  • This repository serves as a boilerplate for developing a robust backend. You can speed up your backend development by using this repository.

Guidelines for use

  • Visit this link to download the code.

  • Alternatively, you can clone the project using the following command:

git clone https://github.com/enayetsyl/backend-boilerplate.git
  • After downloading or cloning the project, open it in VS Code. Open the terminal and run the following command:
npm i
  • In the ".env" file, add your MongoDB URI in the database_url.

  • Run following command in the terminal to start the project

npm run start:dev
  • Open your browser and navigate to localhost:5000 to check whether the app is working properly.

  • Inside each file, there are comments for your guidance. Some comments explain the purpose of the code and provide supporting reading materials.

  • In some files, comments with "TODO" indicate what you need to change if you want to use it for your project. Read them carefully.

  • This boilerplate will save you from writing 730 lines of code, configuring three files, writing seven scripts in the package.json file, and installing 25 packages and dev dependencies.

  • If you have any queries you can connect with me on LinkedIn