Cherry is an open-source code static analysis tool. It allows you to stay on top of your technical debt, capture the value of your work, and recognize your top team members.

# clone the project
git clone [email protected]:cherrypush/cherry.git
cd cherry

# install dependencies
bundle install
npm install

# setup database
docker compose up -d
rails db:setup

# setup local env vars
cp .rbenv-vars.template .rbenv-vars

# launch the server
bin/dev

The env vars step above assumes you're using the rbenv-vars plugin. If you don't have it installed, check their docs here or use an alternative method to load your environment variables.

You can either use Heroku or the fwuensche/cherry image from Docker Hub.

Note that, in both cases, you'll also need a running instance of Postgres and Redis.

In addition to the above-mentioned docs, a great way to get started is to watch some of the live sessions below. This should give you insights on how to navigate the codebase and start contributing.

Cherry CLI (JavaScript):

• Add support for array of globs: https://youtu.be/zPrVUFDcQ5Y
• Sort results of cherry run: https://youtu.be/ZjJqDBLbM-E

Cherry App (Ruby on Rails):

• Add a new API endpoint + controller tests: https://youtu.be/vh1bCTe16Bs
• Fixing N+1 queries on metrics#index: https://youtu.be/isqa9r0SpsA
• Fixing N+1 queries on dashboards#index: https://youtu.be/vcGpfbLuliA

Huge thanks to our top contributors 🙏

Shoot me a message on Twitter 🤠