gem-hunter
Language: TypeScript
Open Collective's API. A GraphQL API powered by Sequelize and PostgreSQL.
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!
nvm install && nvm use.We recommend cloning the repository in a folder dedicated to opencollective projects.
git clone git@github.com:opencollective/opencollective-api.git opencollective/api
cd opencollective/api
npm install
npm run dev
See the dev docs for querying basics.
node-gyp issues related to Python 3 vs Python 2, you can run: npm rebuildIf your setup requires some specific values (e.g. custom database URL), create a .env.test file in the root of the project and set the values there.
To setup the test database, run npm run db:restore:test.
Tests can then be run with npm run test or npm run test:watch (watch mode). Since the full test suite can be quite heavy, we recommend passing the files you want to test as arguments to the command:
npm run test test/server/models/SocialLink.test.tsSummary: This project is currently deployed to staging and production with Heroku. To deploy, you need to be a core member of the Open Collective team.
See: docs/deployment.md
If you have any questions, ping us on Discord.