schuyler1d / code-corps-api

Elixir/Phoenix API for Code Corps.

Code Corps API

This is the Elixir and Phoenix backend API for 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.
• Then check out some GitHub issues to see where you can help out.

You can also always come 👋 hello in our Slack, 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. If we've missed you for some reason, please open an issue in the Ember app!

At the moment, our focus is integration with Stripe, so if you want to help, that would be the most useful spot. Check our Donations milestone to see which parts we need help on. Of course, help with other areas is always welcome, so if that sort of thing isn't your cup of tea, feel free to pick anything else.

Installing with Docker

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 mix commands through Docker
• Stop and start the server
• Run tests
• Linting and Style Guidelines
• Rebuild Docker containers
• Work with the Ember front-end
• Set up environment variables
• Push changes to GitHub

Documentation

We have several types of docs:

• Project documentation (README, CONTRIBUTING, etc.)
• API documentation written in API Blueprint format in blueprint/api.apib and published to the web when merging into develop
• Inline documentation for the Elixir app generated by ex_doc and published to GitHub pages when merging into develop

Want to improve the documentation? Get started here.

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 🙌
• Social impact 🌍
• Good documentation 📝
• Testing 🔬
• Welcoming and teaching new contributors 👋
• Writing small, clear, and achievable issues 🎯

We also track quantifiable metrics like inline documentation coverage, testing coverage, and so on. You can see some of these metrics in the icons at the top of this page.