https://github.com/devonwintz/express-boilerplate

Boilerplate/starter project for quickly building RESTful APIs using Node.js, Express, and Mongoose.
https://github.com/devonwintz/express-boilerplate

boilerplate-node expressjs mongoose nodejs restful-api

Last synced: about 1 month ago
JSON representation

Boilerplate/starter project for quickly building RESTful APIs using Node.js, Express, and Mongoose.

• Host: GitHub
• URL: https://github.com/devonwintz/express-boilerplate
• Owner: devonwintz
• Created: 2021-11-26T22:43:40.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-12-02T23:01:47.000Z (about 3 years ago)
• Last Synced: 2023-03-07T22:47:37.951Z (almost 2 years ago)
• Topics: boilerplate-node, expressjs, mongoose, nodejs, restful-api
• Language: JavaScript
• Homepage:
• Size: 4.11 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Express Boilerplate

A boilerplate/starter project for quickly building RESTful APIs using Node.js, Express, and Mongoose. 



## Directory Structure

## `app.js`

This is your server's main file. It references all required files that further reference to other files. Among the main elements in this file are the instantiation of `express`, `middlewares`, references to the `routes` and the `database connection`. 



## `.env`

All environment variables (configuration constants)are declared in this file. In this template, the database connection string is included. Simply replace `` with the name you wish to use for your collection.
 **Do not include this file when pushing to your remote version control repo, such as Github. To ensure that this file is excluded when you push to your remote repo, add `.env` in your `.gitignore` file.** 



## `models` Subdirectory

In this subdirectory, you will define all models for your collections. A model is a data object schema. It describes the collection fields and their data types, along with other attributes. 



## `routes` Subdirectory

The models defined in the `models` subdirectory are consumed by the routes created in this folder.