AUTHENTICAITON BOILERPLATE

1. Install Dependencies: Install the required Node.js packages using npm:

   npm install

2. Start the Server:

   npm start

Setup Environment Variables

Create a .env file in the root directory of your project. Add environment-specific variables on new lines in the form of NAME=VALUE. For example:

PORT=5000

# mongoDB
MONGO_URI='mongodb connection string'

# jwt 
JWT_SECRET='jwtsecretkey'
JWT_EMAIL_SECRET='jwtsecretkeyforemail'
JWT_MAX_AGE= 3600 * 24 * 7 # 7 days 

# Google auth
GOOGLE_CLIENT_ID='Google client id'
GOOGLE_CLIENT_SECRET='Google client secret'
GOOGLE_CALLBACK_URL='http://localhost:5000/api/auth/google/callback'

# Github auth
GITHUB_CLIENT_ID='Github client id'
GITHUB_CLIENT_SECRET='Github client secret'
GITHUB_CALLBACK_URL='http://localhost:5000/api/auth/github/callback'

# Mailer
EMAIL_USER = '[email protected]'
EMAIL_PASSWORD = 'password'
EMAIL_HOST= 'mail.example.com'
EMAIL_PORT = 465
EMAIL_SECURE = True

# Client url
CLIENT_URL='Client url' 
CLIENT_RESET_URL='Client url for password reset'
CLIENT_OAUTH_REDIRECT_URL='Client url for oauth redirect'
CLIENT_CONFIRM_URL='client url for email confirmation' 

How to start new task:

• Checkout to develop branch (git checkout develop).
• Pull from develop (git pull origin develop)
• Create new brach named as Trello story. (git checkout -b <YOUR TRELLO STORY>)
• After finished, do the IMPORTANT task below.
• Commit and make a PR with develop.
• If any conflicts happen, resolve locally.
• Once everything resolves, reviewer will approve and merge the PR with main.

IMPORTANT: Before commiting anything, make sure husky is working properly. Do this before commit.

• Run npm run fix-lint in the root directory.
• Run npm run pretty in the root directory.

Auth routes:

• POST /api/auth/register - Register new user
• POST /api/auth/login - Auth user & get token
• POST /api/auth/password-reset/get-code - Reset password of user
• POST /api/auth/password-reset/verify/:token - Verify and save new password of user
• GET /api/auth/google - Login with google
• GET /api/auth/google/callback - Callback route for google auth to redirect to
• GET /api/auth/github - Login with github
• GET /api/auth/github/callback - Callback route for github auth to redirect to