README.md
[](https://circleci.com/gh/code-corps/code-corps-api)
[](http://inch-ci.org/github/code-corps/code-corps-api)
[](https://coveralls.io/github/code-corps/code-corps-api?branch=develop)
[](https://beta.hexfaktor.org/github/code-corps/code-corps-api)
[](https://beta.hexfaktor.org/github/code-corps/code-corps-api)
[](http://slack.codecorps.org)
---
This is the [Elixir](http://elixir-lang.org/) and [Phoenix](http://www.phoenixframework.org/) backend API for [codecorps.org](https://www.codecorps.org).
Code Corps is an open source platform for building and funding public software with massive social impact.
Our goals:
- **Connect people** - Match developers and designers, project managers and marketers – any and every talent – to ambitious projects that need their help.
- **Provide support** - Educate and train, develop and encourage people who build public software. Help projects be successful and people to do their best work.
- **Fund projects** - Crowdfund ongoing work and keep funders engaged in projects and connected to the teams they're supporting.
- **Develop new tools** - Help people collaborate on, organize, and even distribute their work. Listen closely to hear what needs built, and then build it.
## How can I help?
We'd love to have you contribute to Code Corps directly!
- First, read the guidelines in our [`CONTRIBUTING.md`](https://github.com/code-corps/code-corps-api/blob/develop/.github/CONTRIBUTING.md).
- Then [look at our current projects](https://github.com/code-corps/code-corps-ember/projects?query=sort%3Acreated-asc) to find something that interests you.
Have questions? Need help? You can also always come :wave: hello [in our Slack](http://slack.codecorps.org), where there are always a ton of us around to help you learn, debug, or just shoot the breeze.
We highlight everyone who's contributed to [the Code Corps team page](https://www.codecorps.org/team). If we've missed you for some reason, please [open an issue in the Ember app](https://github.com/code-corps/code-corps-ember/issues/new)!
## Where should I help?
We recommend checking the latest [milestones on GitHub](https://github.com/code-corps/code-corps-api/milestones) to get a sense for our current priorities.
Of course, help with other areas is always welcome, so if the current milestones aren't your cup of tea, feel free to [browse the issues](https://github.com/code-corps/code-corps-api/issues).
And you can _always_ ask us for advice on where to start [in our Slack](http://slack.codecorps.org).
## Installing
[Follow this guide to get started.](https://github.com/code-corps/code-corps-api/blob/develop/docs/INSTALLING.md)
## Usage
Have everything installed and ready to work? Read [our usage guides](USAGE.md) to learn how to:
- [Run `mix` commands](USAGE.md#interacting-with-the-app)
- [Stop and start the server](USAGE.md#stopping-and-starting-the-server)
- [Run tests](USAGE.md#running-tests)
- [Linting and style guidelines](USAGE.md#linting-code-with-credo)
- [Work with the Ember front-end](USAGE.md#serving-ember)
- [Set up environment variables](USAGE.md#environment)
- [Set up Github Integration](https://github.com/code-corps/code-corps-api/wiki/GitHub-Apps-–-How-to-set-up-your-local-environment)
## Documentation
We have several types of docs:
- Project documentation (README, CONTRIBUTING, etc.)
- API documentation ([`master`](http://docs.codecorpsapi.apiary.io/) | [`develop`](http://docs.codecorpsapidevelop.apiary.io/) | [local](docs/API.md)) written in [API Blueprint](https://apiblueprint.org/) format in [`blueprint/api.apib`](https://github.com/code-corps/code-corps-api/blob/develop/blueprint/api.apib) and published to the web when merging into `develop` or `master`
- [Inline documentation](https://code-corps.github.io/code-corps-api-github-pages) for the Elixir app generated by [`ex_doc`](https://github.com/elixir-lang/ex_doc) and published to GitHub pages when merging into `develop`
Want to improve the documentation? [Get started here.](https://github.com/code-corps/code-corps-api/blob/develop/.github/CONTRIBUTING.md#what-kind-of-documentation-are-you-writing)
## Things we care about
Our values for this project reflect the Code Corps values as a whole, though with some minor differences.
We care about:
- Each other :raised_hands:
- Social impact :earth_africa:
- Good documentation :memo:
- Testing :microscope:
- Welcoming and teaching new contributors :wave:
- Writing small, clear, and achievable issues :dart:
We also track quantifiable metrics like inline documentation coverage, testing coverage, and so on. You can see some of these metrics in the badges at the top of this page.