Carbon Knight Backend

Carbon Knight Backend

This is the Back End repository for the Carbon Knight application, which works in tandem with the Cloverly Microservice. The Microservice connects with the Cloverly API in order to return carbon footprint data, which the Back End then takes and compiles and feeds to the Front End.
Explore the docs »

· Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Configuration
  • Testing
• Contributing
• Contact
• Acknowledgements

About The Project

Please visit the Carbon Knight Front End repository and check out the readme there for a more in depth look at this project!

To view all the repositories associated with Carbon Knight, please visit Carbon Knight

Built With

• Ruby

Getting Started

To properly use this application you will need to set up and configure three repositories. Follow the Configuration directions in each repository to get Carbon Knight running locally! Alternatively, check out the production application here!!!

Configuration

Setting Up the Back-End

1. Clone this repo git clone https://github.com/Carbon-Knight/carbon-knight-back-end.git

2. Enter the directory it was cloned into cd carbon-knight-back-end

3. Run bundle install to install gems and dependencies

4. Run bundle exec rails db:{create,migrate} to set up the database and to run the migrations

5. At this point, please visit Configuration Part II to get the full Carbon Knight Application up and running locally

Testing

RSpec was used for the testing of this project.

Carbon Knight Backend has been fully tested. To view the test coverage;

Once inside your terminal within the Carbon Knight Backend directory run the following command.

open coverage

This will open up a folder with an index.html file. Clicking on this file will show you a list of all the lines of code within this repository, and whether they have been tested or not.

Additionally, running bundle exec rspec will show you the quick summary of the test coverage in this application.

Both open coverage and bundle exec rspec work inside each repository of this application.

Roadmap

See Open Issues or visit our Project Board for a list of proposed features, known issues, and project extensions.

Contributing

Contributions are what make this community such an amazing and fun place to learn, grow, and create! Any contributions you make are greatly appreciated.

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

Schema

Contact

Curtis Bartell        - - GitHub

Jonathan Wilson - - GitHub

Carson Jardine    - - GitHub

Eugene Theriault - - GitHub

Roberto Basulto  - - GitHub

James Belta         - - GitHub

Joshua Carey      - - GitHub

Kiera Allen           - - GitHub

Sean Steel           - - GitHub

Project Link: Carbon Knight