Backend delpoyed at AWS Beanstalk
To get the server running locally:
- Clone this repo
- npm install to install all required dependencies
- npm run server to start the local server
- npm run test to start server using testing environment
-
Express.js makes development easy by allowing us to create secure, modular, and fast applications.
-
Express.js is an unopinionated framework, meaning there isn't any strict and determined rules on how to deal with certain requests. We can create our own custom middleware to handle requests in the ways we wish.
Api docs are HERE
- To update the documentation for the API npm run docs
{
id: UUID
name: STRING
}
{
id: UUID
firstName: STRING
lastName: STRING
email: STRING
password: STRING
roleId: UUID foreign key in ROLES table
}
find()
-> Returns all roles
find()
-> Returns all users
updateUser(changes, email)
-> Update a user by email
deleteUser(id)
-> Delete a user by id
findByEmail(email)
-> Find a user by email
add(values)
-> Insert a new user into DB
findByRole(role)
-> Find users by role name
In order for the app to function correctly, the user must set up their own environment variables.
create a .env file that includes the following:
* JWT_ADMIN - you can create a secret to be attached to token generated for all admin accounts
* JWT_MANAGER - you can create a secret to be attached to token generated for all manager accounts
* JWT_STUDENT - you can create a secret to be attached to token generated for all manager accounts
* ADMIN_SECRET - a string used to authenticate a user is of type admin to prevent all other user types from accessing protected routes.
* DB_ENV - set to "development" until ready for "production" or "staging"
* NODE_ENV - set to "development" until ready for "production" or "staging"
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Frontend Documentation for details on the frontend of our project.