https://github.com/opencollective/contributors-svg
https://github.com/opencollective/contributors-svg
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/opencollective/contributors-svg
- Owner: opencollective
- License: mit
- Created: 2021-08-16T20:15:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T21:51:35.000Z (5 months ago)
- Last Synced: 2024-10-30T05:43:34.621Z (4 months ago)
- Language: JavaScript
- Size: 27 MB
- Stars: 9
- Watchers: 4
- Forks: 3
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - opencollective/contributors-svg - (JavaScript)
README
# Contributors SVG
[](https://david-dm.org/opencollective/contributors-svg)
## 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](https://github.com/creationix/nvm): `nvm install && nvm use`.
2. Make sure you have [GraphicsMagick](http://www.graphicsmagick.org) installed.
- On Debian/Ubuntu: `sudo apt-get install graphicsmagick`
- On MacOS (with [Homebrew](https://brew.sh/)): `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:
- clone, install and start [opencollective-api](https://github.com/opencollective/opencollective-api)
- in this project, copy [`.env.local`](.env.local) to `.env`.
### 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
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:
- https://github.com/heroku/heroku-buildpack-apt
- https://github.com/MikeKoval/heroku-buildpack-graphicsmagick
- heroku/nodejs
### 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
```
- URL: https://contributors-svg.opencollective.com/
## Troubleshooting
### Inspecting the Redis cache (production)
```
heroku redis:cli --app contributors-svg
```