Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.66 KB

README.md

File metadata and controls

44 lines (29 loc) · 1.66 KB

Express Boilerplate!

About

Petful server is designed to work with the Petful client interface. Petful is a first in first out adoption agency. This server stores and serves the queue for dogs, cats, and people.

GET /api/dog/ returns the next dog /api/cat/ returns the next cat /api/people/next returns the next person /api/people/all returns all people

DELETE - when a pet is adopted, they get deleted from the list /api/dog/ removes the dog from the queue and returns it /api/cat/ removes the next cat from the queue and returns it /api/people/next removes the next person from the queue and returns it

This app was built using Node, Express, and React

This is a boilerplate project used for starting new projects!

How do 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 in watch mode 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 master branch.