文件列表:

LICENSE (1057, 2021-04-30)
_gitignore (1624, 2021-04-30)
code_of_conduct.md (2257, 2021-04-30)
gateway.js (1389, 2021-04-30)
package-lock.json (167160, 2021-04-30)
package.json (978, 2021-04-30)
pull_request_template.md (1147, 2021-04-30)

# API Documentation #### Backend staged at [Heroku](https://quality-hub-gateway-staging.herokuapp.com/)
## Getting started To get the server running locally: - Clone this repo - **yarn install** to install all required dependencies - **yarn server** to start the local server - **yarn test** to start server using testing environment ### Node.js + graphql-yoga + Prisma 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 ## Endpoints #### Organization Routes 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. ## Data Model Specific schemas (data models, queries, mutations) for each of the connected GraphQL back-end APIs can be accessed at the links above. ## Environment Variables 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" - JWT*SECRET - 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 ## Contributing 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](./code_of_conduct.md). Please follow it in all your interactions with the project. ### Issue/Bug Request **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. ### Feature Requests 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. ### Pull Requests 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. #### Pull Request Guidelines - 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. ### Attribution These contribution guidelines have been adapted from [this good-Contributing.md-template](https://gist.github.com/PurpleBooth/b24679402957c63ec426). ## Documentation See [Frontend Documentation](link to your frontend readme here) for details on the frontend of our project.

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：