Code Corps Rails API
The Code Corps API is an open source Rails::API backend that powers the Code Corps platform. It includes:
- developer and project matchmaking
- project management tooling
- a donations engine that distributes donations to projects
Contributing
We'd love to have you contribute to Code Corps directly!
To do so, please read the guidelines in our CONTRIBUTING.md.
Then check out some GitHub issues to see where you can help out.
Installing
To make your life easier, you can just clone this repository and use our Docker container. Follow this guide to get started.
Usage
Have everything installed and ready to work? Read our usage guides to learn how to:
- Run normal Rails commands through Docker
- Run tests
- Stop and start the server, and rebuild Docker containers
- Push changes to GitHub
- Serve the Ember app's
index.html - Debug with
pry-remote
API Docs
Want to see documentation for the API endpoints?
Documentation is available on Apiary for the following branches:
master(api.codecorps.org): http://docs.codecorpsapi.apiary.io/develop(api.pbqrpbecf.org and api.pbqrpbecf-qri.org): http://docs.codecorpsapidevelop.apiary.io/
Read our guide to see how to generate API docs locally as you develop.
Built with
- Rails — Our backend API uses Rails 5 in its API-only configuration.
- ActiveModelSerializers - We use AMS to serialize the JSON responses from our API.
- Ember.js — Our frontend is an Ember.js app that communicates with the Rails JSON API.
- PostgreSQL — Our primary data store.
- Redis — Redis for a variety of NoSQL uses.
- Elasticsearch — Elasticsearch for searching documents.
- Docker — Docker for containerized development environments.