Backend staged at Heroku
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 test to start server using testing environment
We chose this framework for:
- Scalability: since the QualityHub project currently includes Core and InterviewQ (but will include future modules, like ResumeQ, etc.), we wanted to set up a gateway that would connect the different back-ends
- Simplicity: we wanted to set up a gateway so that the various front-end apps associated with the QualityHub project would only need to hit one endpoint
- Flexibility: we chose to implement GraphQL to make it easier for future front-end developers to access the backend schema
The Gateway current connects the following GraphQL back-end APIs:
QualityHub Core: https://quality-hub-core-staging.herokuapp.com
InterviewQ: https://qh-interviewq-practice-01.herokuapp.com
The overall schema for the project can be accessed at the GraphQL playground here: https://quality-hub-gateway-staging.herokuapp.com
Specific schemas can be accessed at the playgrounds linked to above.
Specific schemas (data models, queries, mutations) for each of the connected GraphQL back-end APIs can be accessed at the links above.
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:
_ STAGING_DB - optional development db for using functionality not available in SQLite _ NODE*ENV - set to "development" until ready for "production"
- JWTSECRET - you can generate this by using a python shell and running import random''.join([random.SystemRandom().choice('abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&(-_=+)') for i in range(50)]) _ SENDGRID_API_KEY - this is generated in your Sendgrid account * stripe_secret - this is generated in the Stripe dashboard
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](🚫link to your frontend readme here) for details on the frontend of our project.
To run the Gateway with locally-deployed versions of the federation members, use the command npm run development. Inside of /config there is an env file which contains variables for locally-deployed federation members.
gateway.js expects the following environment variables:
RESUMEQ_ENDPOINTdirects gateway to ResumeQ backend.INTERVIEWQ_ENDPOINTdirects gateway to InterviewQ backend.CORE_ENDPOINTdirects gateway to Core backend.GATEWAY_PORTsets the port of the gateway.