🔐 auth-api-starterpack

Custom, authenticated API instructions and starter pack for BEW1.2 students!

Installation

1. Fork this repository and clone your fork locally.

2. Open the repository folder in your editor of choice:

   $ cd auth-api-starterpack
   $ atom .

3. Move the contents of this README.md file to docs/requirements.md.

   $ mv README.md docs/requirements.md
   $ touch README.md

4. Add your project's title in the header, save, and close README.md.

5. Navigate to the src directory in your terminal.

6. Copy the contents of example .env.example file to .env:

   $ cp .env.example .env

7. Run nvm use to activate the v8.11.1 node environment.

8. Run yarn install to install project dependencies into the activated environment.

9. Execute yarn start to run the development server.

Development

#TODO === Hint

• I've added helpful #TODO placeholders, comments, and hints throughout the project to jog your memory in case you need a hand! Simply CTRL + Shift + F to Find All in your editor, and search for #TODO. You'll find a helpful list of hints waiting for you!

Syncing Your Fork

• Remember to periodically sync your forked repository in order to get the latest updates to auth-api-starterpack integrated into your own projects! Simply follow this helpful guide to learn how.

Deployment

Heroku

Follow this Node.js Deployment Guide to deploy your application on Heroku. Be sure to complete all of the steps!

[BEW1.2] Project Requirements

• View the requirements document in the Class Repository.