khan-ngo / rails-api-bdd-diagnostic

Rails API BDD Diagnostic

Prerequisites

• https://github.com/ga-wdi-boston/rails-api-bdd

Instructions

1. Fork and clone this repository.
2. Change into the new directory.
3. Install dependencies with bundle install
4. Create a .env for sensitive settings (touch .env).
5. Generate new development and test secrets (bundle exec rake secret).
6. Store them in .env with keys SECRET_KEY_BASE_<DEVELOPMENT|TEST> respectively.
7. Create and checkout a new branch, named response.
8. Follow the directions given in lib/diagnostic.rb.
9. Before the allotted time is up, push to your fork and issue a pull request.

Your pull request description should contain a "fist to five" for comfort and clarity. Additionally, you should mention the resources you used to help you complete this diagnostic. For example:

Comfort: 3
Clarity: 3

I used Google and my class notes to help with this diagnostic.

Tasks

Developers should run these often!

• bin/rake routes lists the endpoints available in your API.
• bin/rake test runs automated tests.
• bin/rails console opens a REPL that pre-loads the API.
• bin/rails db opens your database client and loads the correct database.
• bin/rails server starts the API.
• scripts/*.sh run various curl commands to test the API. See below.

You may wish to refer to "How do I submit diagnostics?" and other FAQs related to forking, cloning, and pull requests.

You may use any resource other than each other to complete this diagnostic. This includes referencing talk materials, appropriate documentation, and searching for help online.

License

1. All content is licensed under a CC­BY­NC­SA 4.0 license.
2. All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact [email protected].