lynxmasters-api

Lynxmasters Api Lynxmasters UI

Table of Contents

• Contributing
• Running Locally
• API Testing
• Testing Sendgrid Locally
• Contributors

Contributing

To contribute to this project we ask that everyone follow the processes needed to avoid conflicts and issues with development lifecycle.

1. Following the issue tracker, pick your selected work focus

2. Create your own work branch following the described nomanclature: name/user-endpoints or name/email-verification

3. Commit and push your local changes to remote, adding the issue # you're working on in the commit message. This will reference your commit in the issue.

Example: "#ISSUE_NUMBER: commit message"

git commit -m "#12: user endpoints completed"

4. Open a Pull Request (Resolve any merge conflicts if needed)
5. Add the following reviewers @ianarsenault @j-arsenault @tylerdcorwin @nmonty9
6. Once peer reviewed your pull request will either be merged or changes will be requested

Run Locally

Install MongoDB

To run MongoDB

# starts mongodb
mongod

Next you will need to configure an env file

cp example.env .env

Open the newly created .env file and update the environment:

DEV_UPLOAD_LOCATION="/your/path/to/lynxmasters-ui/static/uploads"
NODE_ENV="dev"

To run API

cd path/to/project/root

# install dependencies
npm install

# run server at localhost:8081
npm run dev

For PC

# run server at localhost:8081
npm run dev:pc

Testing SendGrid Locally

1. In server directory, create a new directory called config

cd path/to/project/root

# creates config directory
mkdir config

cd config

2. Create a .env file for sendgrid variables

# create .env file named sendgrid.env
echo "SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env

3. Open up sendgrid.env and edit it to the following

SENDGRID_API_KEY='YOUR_SENDGRID_API_KEY_HERE'
NO_REPLY_EMAIL='do_not_reply@example.com'
SUBJECT='Custome subject....'

4. Sendgrid will now work

Contributors

Nick Montalbano	Ian Arsenault	Tyler Corwin	Jameson Arsenault