Skip to content

Latest commit

 

History

History
110 lines (72 loc) · 4.58 KB

README.md

File metadata and controls

110 lines (72 loc) · 4.58 KB
Raw

CI

Rate Repository API

This is a GraphQL API for the Rate Repository application.

✔️ Requirements

Works at least with Node version v20. If you haven't installed Node or npm, 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. ensure that you are using the right Node version, f. ex.:
$ node -v
v20.11.0

  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 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 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.

NOTE The port 5000 might be reserved in new macOS versions. If you see this error

Error: listen EADDRINUSE: address already in use :::5000

define an alternative port in file .env. You may eg. pick 5001:

PORT=5001

Change also the Authorization callback URL here to have the new port value.

🔑 Authentication

To list all the registered users, you can run this query in the Apollo Sandbox:

{
  users {
    edges {
      node {
        username
      }
    }
  }
}

You can retrieve an access token by performing the authenticate mutation:

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:

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:

{
  "Authorization": "Bearer <ACCESS_TOKEN>"
}

Replace the <ACCESS_TOKEN> 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 ORM, and changing the underlying database driver is just a matter of configuration.