Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippeWS authored May 29, 2022
1 parent 47a883f commit c9524d0
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
# BE-scheduling

## Accessible FrontEnd Link:
https://dog-groomings.herokuapp.com/

## Accessible BackEnd Link:
Accessible Link:
https://dog-grooming-api.herokuapp.com/

## Quick Start Instructions
1. Clone Github Repository to Local Machine.
2. Run `npm install` to install all necessary packages.
3. Create .env file in the root folder.
4. Add the following variables
`MONGODB_URI: Description: The URL to the cloud hosted DB
PASSWORD_SALT: Salt used in encrypting passwords
TOKEN_SECRET: Used to verifty user JWT
PORT: Port to utilize should the connection to the cloud hosted DB fail`
5. Run `npm run dev` to launch.

# CI/CD Steps:
npm ci
npm run build --if-present
Expand Down

0 comments on commit c9524d0

Please sign in to comment.