Skip to content

ben-jervis-old/operationcode_backend

 
 

README

Hacktoberfest

If you're here looking for a place to contribute pull requests as part of GitHub's "Hacktoberfest", you're in the right place! Please look forward to an increased amount of documentation and tickets. We highly recommend joining our organization at operationcode.org to receive an invite to our Slack team. From there, you'll join the #oc-projects channel. You can get help from multiple professional developers and people who have worked on the application since day 1! Happy hacking!

Tech Summary

  • Ruby version 2.3.3
  • System dependencies PostgreSQL 9.5.6 React 2.0.1

Operation Code allows veterans to find a mentor in the field of software development.

  • Once they have joined, users can select whether they are a mentor or a mentee.

  • Mentees can request a mentoring session. Mentors respond to those requests and can create squads of their own. Squads are groups of the mentees and a mentor (or more than 1) with a common interest or goal.

Diagrams can be found at (doc/data_models): ...doc/data_models/request.png - Illustrates how a mentee user can request a mentoring session ...doc/data_models/squad.png - Illustrates the mentor/mentee relationship of a squad.

Contributing

We use Apiary for our API documentation, API mocking server, etc.

Please ensure that any PRs that change the behavior of the API are updated in the documentation as well. The API blueprint file is at apiary.apib, and the documentation itself is at http://docs.operationcodeapi.apiary.io/.

License

This project is licensed under the terms of the MIT license.

About

This is the backend repo for the Operation Code website

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Ruby 81.7%
  • API Blueprint 9.7%
  • HTML 5.4%
  • Shell 2.5%
  • Makefile 0.7%