https://github.com/johnakhilomen/noteful-server

https://github.com/johnakhilomen/noteful-server

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/johnakhilomen/noteful-server
• Owner: johnakhilomen
• Created: 2021-05-28T03:46:49.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-08-03T18:37:05.000Z (over 3 years ago)
• Last Synced: 2023-05-19T20:27:13.187Z (over 1 year ago)
• Language: JavaScript
• Size: 4.24 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# express-boilerplate

This is a boilerplate project used for starting new projects!

## Set up

Complete the following steps to start a new project (NEW-PROJECT-NAME):

1. Clone this repository to your local machine `git clone BOILERPLATE-URL 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-PROJECT-NAME 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.