Skip to content

opencollective/contributors-svg

Repository files navigation

Contributors SVG

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 >= 14. We recommend using version 14, the one used in CI and production.
  • We recommend using nvm: nvm install && nvm use.
  1. 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 [email protected]:opencollective/contributors-svg.git opencollective/contributors-svg
cd opencollective/contributors-svg
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:

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

None

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:

Staging

None

Production (heroku)

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

Prerequisite

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

Deploy

npm run deploy:production

Troubleshooting

Inspecting the Redis cache (production)

heroku redis:cli --app contributors-svg

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published