search

OperationCode / operationcode_backend

This is the backend repo for the Operation Code website
https://operationcode.org
MIT License
62 stars 108 forks source link

readme


Operation Code Hacktoberfest Banner

License: MIT Twitter Follow GitHub contributors

Build Status View performance data on Skylight Good First Issue

Welcome!

This is the back-end application for OperationCode. We highly recommend joining our organization to receive an invite to our Slack team. From there, you'll want to join the #oc-projects and #oc-ruby-projects channels. You can get help from multiple professional developers.

Before contributing, please review our Contributing Guide

Maintainers

For information about the maintainers of the project, check out MAINTAINERS.md.

Quick Start

If you're unsure of how to start this app or code for it, don't worry! You're our target audience! Please read our Contributing Guide to learn everything you need to be able to ask the right questions on our Slack team.

In continuing with the quick start instructions, it is assumed that you are no stranger to Rails Applications, and standard GitHub workflows such as forking, cloning, and branching.

Recommended versions of tools used within the repo:

Expand To View Quickstart
  1. Install Dependencies (git, gnu make, docker)
  2. Retrieve Codebase
  3. Setup Database
  4. Setup Codebase
  5. Interact with Codebase
## Description If you'd like to learn more about what this project is what a Backend is you can read about this in our [Introduction Guide](CONTRIBUTING.md#explanations). ## Wiki We also have a [wiki](https://github.com/OperationCode/operationcode_backend/wiki) that contains common tutorials, tips, workflows and documentation around how to successfully contribute to, and work within, the operationcode_backend repository. ## Postmortem Reports
Click to expand As incidents happen that require a great deal of troubleshooting and reveal a certain lack of domain knowledge, we wish to document these issues in way that can be used for contributors to learn. When such an event happens and a Root Cause Analysis is performed these issues will be added here. For the purpose of security we need to ensure that no data is added to AAR that would compromise any operation code asset. These reports are intended to document issues and reasoning for future contributors and assist future investigations. In these reports we keep the details blameless and focus on how we can improve and iterate in a better manner.
  1. Slack User invites Stopped link
## License MIT Licensed , see [LICENSE](LICENSE) for details