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!
- Make sure you have Node.js version >= 14. We recommend using version 14, the one used in CI and production.
- We recommend using nvm:
nvm install && nvm use.
- Make sure you have GraphicsMagick installed.
- On Debian/Ubuntu:
sudo apt-get install graphicsmagick - On MacOS (with Homebrew):
brew install graphicsmagick
We recommend cloning the repository in a folder dedicated to opencollective projects.
git clone git@github.com:opencollective/contributors-svg.git opencollective/contributors-svg
cd opencollective/contributors-svg
npm install
This project requires an access to the Open Collective API.
By default, it will try to connect to the Open Colllective staging API, you don't have to change anything.
If case you want to connect to the Open Collective API running locally:
- clone, install and start opencollective-api
- in this project, copy
.env.localto.env.
npm run dev
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.
None
To deploy to staging or production, you need to be a core member of the Open Collective team.
We're currently relying on the following Heroku buildpacks:
- https://github.com/heroku/heroku-buildpack-apt
- https://github.com/MikeKoval/heroku-buildpack-graphicsmagick
- heroku/nodejs
None
To deploy to staging or production, you need to be a core member of the Open Collective team.
Install the Heroku CLI
npm install -g heroku
Login on the Heroku CLI
heroku login
Configure production remote
git remote add production https://git.heroku.com/contributors-svg.git
npm run deploy:production
heroku redis:cli --app contributors-svg