CodeHerdAPI

A place to corral all things project related into one central location.

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
   • Project Links
   • Backend
   • Frontend
7. Acknowledgements

About The Project

Welcome to CodeHerdAPI! This is the backend application for CodeHerd, a One-App-To-Rule-Them-All approach for Turing students to organize their projects.

With CodeHerd, searching Slack high and low for that one link to that great resource a peer shared or remembering which of the 50 open tabs is the project requirements will be a thing of the past. CodeHerd gives Turing students one central location for all things project related.

To start, a student will sign into CodeHerd using GitHub authorization. From there they can create a project and begin to gather and store all the information they could ever want. With their GitHub account already accessible, it's as easy as pie to link a repository to the project they've created. The student can even hand over the reigns, so to speak, by adding collaborators to their project. Once added, a collaborator can contribute to the project by adding links to helpful resources and any necessary documentation; they'll also have access to DTR templates, pull request templates, and much more.

The best thing? The student will have their body of work in one place to find a resource that can help on a future project or determine which two or three projects are perfect to show off their radical coding skills on their resume. We know CodeHerd holds the promise of becoming a robust application to answer the needs of Turing students. This is just the first iteration after all!

Built With

• Ruby on Rails
• GraphQL Ruby
• Omniauth

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• You'll need to create the Github Key and Secret by creating a Github OAuth app. https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app

Installation

1. Clone the repo

   git clone https://github.com/Turing-Project-Manager/CodeHerdAPI.git

2. Install gems

   bundle install

3. Install figaro

   bundle exec figaro install

4. In application.yml file add the following keys under the exact names:

   GitHub key as `GITHUB_KEY`
   GitHub secret as `GITHUB_SECRET`
   CORS origin as `CORS_ORIGINS`
    This ENV VAR is to set the allowed origins for CORS

5. Run rails db:{create,migrate}

Usage

For more examples, please refer to: GraphQL Queries & Mutations

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Do you have an idea to take CodeHerdAPI to the next level? Rad!! We want to see!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Back-End Team:

• Taija Warbelow - Linkedin - GitHub - [email protected]

• Zach Green - Linkedin - GitHub - [email protected]

• Leigh Cepriano Pulzone - Linkedin - GitHub - [email protected]

Front-End Team:

• Shawn McMahon - Linkedin - GitHub - [email protected]

• Ashton Huxtable - Linkedin - GitHub - [email protected]

Project Links:

• Organization Link: Turing Project Manager

• BE Project Link: CodeHerdAPI

• FE Project Link: CodeHerd

Acknowledgements

• README Template Source
• Turing Requirements