CodeLikeAGirl29 / express-boilerplate

These type of boilerplates are generally kind of “Starter Kits” aka bare-bones. It focuses on fast prototyping by creating the elements which are necessary only for new projects. These require less functionality and are not scalable over time and project.

Express Boilerplate

For starting new Node/Express projects more quickly with a foundation.

Set up

Complete the following steps to start a new project:

1. Clone this repository to your local machine git clone https://github.com/CodeLikeAGirl29/express-boilerplate NEW-PROJECTS-NAME
2. cd into the cloned repository
3. Make a fresh start of the git history for this project with rm -rf .git && git init
4. Install the node dependencies npm install
5. Move the example Environment file to .env that will be ignored by git and read by the express server mv example.env .env
6. Edit the contents of the package.json to use NEW-PROJECTNAME instead of "name": "express-boilerplate",

Scripts

Start the application npm start Start nodemon for the application npm run dev Run the tests npm test

Deploying

When your new project is ready for deployment, add a new Heroku application with heroku create. This will make a new git remote called "heroku" and you can then npm run deploy which will push to this remote's main branch.