Skip to content

Latest commit

 

History

History
102 lines (62 loc) · 2.86 KB

README.md

File metadata and controls

102 lines (62 loc) · 2.86 KB
Raw

Open Collective REST API

Dependency Status

Foreword

If you see a step below that could be improved (or is outdated), please update the instructions. We rarely go through this process ourselves, so your fresh pair of eyes and your recent experience with it, makes you the best candidate to improve them for other users. Thank you!

Development

Prerequisite

  1. Make sure you have Node.js version >= 16.
  • We recommend using nvm: nvm install && nvm use.

Install

We recommend cloning the repository in a folder dedicated to opencollective projects.

git clone git@github.com:opencollective/opencollective-rest.git opencollective/rest
cd opencollective/rest
npm install

Environment variables

This project requires an access to the Open Collective API. You have two options:

  • cp .env.staging .env to connect to the Open Collective staging API
  • cp .env.local .env to connect to the API running locally

If you decide to pick the local strategy, make sure you install and run the opencollective-api project.

Start

npm run dev

Contributing

Code style? Commit convention? Please check our Contributing guidelines.

TL;DR: we use Prettier and ESLint, we do like great commit messages and clean Git history.

Tests

You can run the tests using npm test or more specifically:

  • npm run test:server

To update:

  • GraphQL schema for eslint: run npm run graphql:update

Deployment

To deploy to staging or production, you need to be a core member of the Open Collective team.

(Optional) Configure Slack token

Setting a Slack token will post a message on #engineering with the changes you're about to deploy. It is not required, but you can activate it like this:

  1. Go to https://api.slack.com/custom-integrations/legacy-tokens
  2. Generate a token for the OpenCollective workspace
  3. Add this token to your .env file:
OC_SLACK_DEPLOY_WEBHOOK=https://hooks.slack.com/services/....

Staging (heroku)

# Before first deployment, configure staging remote
git remote add staging https://git.heroku.com/oc-staging-rest-api.git

# Then deploy main with
npm run deploy:staging

URL: https://rest-staging.opencollective.com/

Production (heroku)

# Before first deployment, configure production remote
git remote add production https://git.heroku.com/oc-prod-rest-api.git

# Then deploy main with
npm run deploy:production

URL: https://rest.opencollective.com/

Discussion

If you have any questions, ping us on Discord or Twitter (@opencollect).