Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaltsoon/rate-repository-api
⭐ GraphQL API for rating GitHub repositories
https://github.com/kaltsoon/rate-repository-api
graphql javascript
Last synced: 6 days ago
JSON representation
⭐ GraphQL API for rating GitHub repositories
- Host: GitHub
- URL: https://github.com/kaltsoon/rate-repository-api
- Owner: Kaltsoon
- License: mit
- Created: 2020-02-16T08:34:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-11T23:21:34.000Z (over 1 year ago)
- Last Synced: 2023-04-06T05:12:20.289Z (over 1 year ago)
- Topics: graphql, javascript
- Language: JavaScript
- Homepage:
- Size: 1.89 MB
- Stars: 6
- Watchers: 2
- Forks: 56
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rate Repository API
This is a GraphQL API for the Rate Repository application implemented in [Full Stack Open course's React Native part](https://fullstackopen.com/en/part10).
## ✔️ Requirements
Tested with Node version 16, but later versions _might_ work as well) and npm. If you haven't installed Node or npm, [nvm](https://github.com/nvm-sh/nvm) is an easy to use tool for installing both. Nvm is also handy if you want to quickly switch between different Node versions.
## 🚀 Getting started
1. Clone this repository and run `npm install` in the `rate-repository-api` directory.
2. Rate Repository API uses the GitHub API, which has a quite small rate limit (60 requests per hour) for unauthorized requests. Therefore, we need to register it as an OAuth application to obtain client credentials. Register your OAuth application [here](https://github.com/settings/applications/new) by setting "Application name" as "Rate Repository API", "Homepage URL" as https://github.com/Kaltsoon/rate-repository-api and "Authorization callback URL" as http://localhost:5000. Now you should see your application [here](https://github.com/settings/developers) and by going to the application's page, see the "Client ID" and "Client Secret" values.
3. Create a file `.env` in the `rate-repository-api` directory and copy the contents of the `.env.template` file there. In the `.env` file, replace `GITHUB_CLIENT_ID`, and `GITHUB_CLIENT_SECRET` variable values with your newly registered OAuth application's credentials. If you want, you can also use a different secret for the `JWT_SECRET` variable, which is used to sign access tokens.
4. Run `npm run build`. This will setup the SQLite database and run the migrations.
5. To populate the database with some seed data, run `npm run seed:run`. **Note:** running this command will remove all existing data.
6. All done! Just run `npm start` to start the server. After the server has started you should be able to access the Apollo Sandbox at http://localhost:4000.
## 🔑 Authentication
To list all the registered users, you can run this query in the Apollo Sandbox:
```javascript
{
users {
edges {
node {
username
}
}
}
}
```
You can retrieve an access token by performing the `authenticate` mutation:
```javascript
mutation {
authenticate(credentials: { username: "kalle", password: "password" }) {
accessToken
}
}
```
All access tokens expire after **seven days**. If you performed step 5. in the "Getting started" section, users "kalle", "elina" and "matti" all have the password "password".
You can also register a new user by performing the `createUser` mutation:
```javascript
mutation {
createUser(user: { username: "myusername", password: "mypassword" }) {
id
username
}
}
```
### Authorize requests in the Apollo Sandbox
A handy way to authorize requests in the Apollo Sandbox is to retrieve an access token using the `authorize` mutation (see above for details) and then add the following in the "Headers" tab below the operations editor:
```json
{
"Authorization": "Bearer "
}
```
Replace the `` part with your access token.
## 📖 Documentation
Apollo Sandbox offers documentation on how to use the API. Start the server by running `npm start`, open the Apollo Sandbox at http://localhost:4000 and you should be able to see the documentation next to the operations editor.
## 🐛 Found a bug?
Submit an issue with the bug description and a sway to reproduce the bug. If you have already come up with a solution, we will gladly accept a pull request.
## ❓ FAQ
- **How to reset the database?** If you are absolutely sure that you want to remove _all_ the existing data, just remove the `database.sqlite` file in the `rate-repository-api` directory and run `npm run build`. You can run `npm run seed:run` to initialize the new database with seed data.
- **Is this production ready?** Almost. The current version of the API utilizes the SQLite database, which is not quite suitable for production. Luckily, all database queries are performed with [Objection](https://vincit.github.io/objection.js/) ORM, and changing the underlying database driver is just a matter of [configuration](http://knexjs.org/#Installation-client).