https://github.com/opencollective/opencollective-rest
Open Collective's REST API legacy, v1, and v2!
https://github.com/opencollective/opencollective-rest
Last synced: 5 months ago
JSON representation
Open Collective's REST API legacy, v1, and v2!
- Host: GitHub
- URL: https://github.com/opencollective/opencollective-rest
- Owner: opencollective
- License: mit
- Created: 2019-02-27T16:10:21.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T16:04:36.000Z (6 months ago)
- Last Synced: 2024-10-30T05:43:52.576Z (6 months ago)
- Language: TypeScript
- Homepage: https://rest.opencollective.com
- Size: 43.1 MB
- Stars: 47
- Watchers: 16
- Forks: 24
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - opencollective/opencollective-rest - Open Collective's REST API legacy, v1, and v2! (TypeScript)
README
# Open Collective REST API
[](https://david-dm.org/opencollective/opencollective-rest)
## 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](https://github.com/creationix/nvm): `nvm install && nvm use`.
### Install
We recommend cloning the repository in a folder dedicated to `opencollective` projects.
```
git clone [email protected]: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](https://github.com/opencollective/opencollective-api) project.
### Start
```
npm run dev
```
## Contributing
Code style? Commit convention? Please check our [Contributing guidelines](CONTRIBUTING.md).
TL;DR: we use [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/), 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:
```bash
OC_SLACK_DEPLOY_WEBHOOK=https://hooks.slack.com/services/....
```
### Staging (heroku)
```bash
# 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)
```bash
# 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](https://discord.opencollective.com) or Twitter
([@opencollect](https://twitter.com/opencollect)).