Skip to content

iak97/rails_todo_api

Repository files navigation

Rails Todo API

This is a Rails API only application using TDD RSpec Testing and included SimpleCov gem for code coverage. It allows users to add and manage their todos 📝.

Prerequisites

Before cloning this repository, please ensure that you have the following installed on your local machine:

  • Ruby 💎 > 3
  • Rails 🛤️ > 7

Installation ⏬

To get started with the project, follow these steps:

1. Clone the repository 📂:

git clone [email protected]:iak97/rails_todo_api.git

2. Change into the project directory ↪️ :

cd rails_todo_api

3. Install the required gems 🔮:

bundle install

4. Edit config/database.yml file with your db credentials 💾.

5. Create the database and run the migrations 🏃:

rails db:create db:migrate

6. Start the Rails server 🚀:

rails s

7. To run specs 💡:

rspec

8. Access the API in your Postman 🌐 at http://localhost:3000.

Note

If you encounter any issues please let me know. Give me a 🌟 if you like this project!!!