Giter VIP home page Giter VIP logo

express-boilerplate's Introduction

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 <db_username with your mongodb username and <db_name> 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.

express-boilerplate's People

Contributors

devonwintz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.