Open Collective Images
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
- Make sure you have Node.js version >= 10. We recommend using version 10, the one used in CI and production.
- We recommend using nvm:
nvm install.
- Make sure you have GraphicsMagick installed.
- On Debian/Ubuntu:
sudo apt-get install graphicsmagick - On MacOS (with Homebrew):
brew install graphicsmagick
Install
We recommend cloning the repository in a folder dedicated to opencollective projects.
git clone git@github.com:opencollective/opencollective-images.git opencollective/images
cd opencollective/images
npm install
Environment variables
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.
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.
Deployment
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/bogini/heroku-buildpack-graphicsmagick
- heroku/nodejs
Staging (heroku)
# Before first deployment, configure staging remote
git remote add staging https://git.heroku.com/oc-staging-image-server.git
# Then deploy main with
npm run deploy:staging
Production (heroku)
# Before first deployment, configure production remote
git remote add production https://git.heroku.com/oc-prod-image-server.git
# Then deploy main with
npm run deploy:production