Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opencollective/opencollective-images
Open Collective's Image Server. For badges, banners, avatar, etc ...
https://github.com/opencollective/opencollective-images
Last synced: 17 days ago
JSON representation
Open Collective's Image Server. For badges, banners, avatar, etc ...
- Host: GitHub
- URL: https://github.com/opencollective/opencollective-images
- Owner: opencollective
- License: mit
- Created: 2018-09-18T08:51:48.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T15:46:09.000Z (3 months ago)
- Last Synced: 2024-10-30T05:43:52.519Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://images.opencollective.com
- Size: 28.3 MB
- Stars: 57
- Watchers: 10
- Forks: 30
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - opencollective/opencollective-images - Open Collective's Image Server. For badges, banners, avatar, etc ... (JavaScript)
README
# Open Collective Images
[](https://david-dm.org/opencollective/opencollective-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
1. Make sure you have Node.js version >= 18. We recommend using version 18, the one used in CI and production.
- We recommend using [nvm](https://github.com/creationix/nvm): `nvm install`.
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/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](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
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/MikeKoval/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
```
- URL: https://images-staging.opencollective.com/
### 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
```
- URL: https://images.opencollective.com/