https://github.com/iak97/rails_todo_api

A todo api using ruby on rails with rspec
https://github.com/iak97/rails_todo_api

rails rails-api rails-application rails7 rspec rspec-rails rspec-testing ruby ruby-app ruby-on-rails

Last synced: 13 days ago
JSON representation

A todo api using ruby on rails with rspec

• Host: GitHub
• URL: https://github.com/iak97/rails_todo_api
• Owner: iak97
• Created: 2023-12-05T16:26:42.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-24T07:11:32.000Z (about 1 year ago)
• Last Synced: 2024-12-03T15:43:03.014Z (about 1 month ago)
• Topics: rails, rails-api, rails-application, rails7, rspec, rspec-rails, rspec-testing, ruby, ruby-app, ruby-on-rails
• Language: HTML
• Homepage:
• Size: 196 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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 📂:

```bash

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

```

## 2. Change into the project directory ↪️ :

```bash

cd rails_todo_api

```

## 3. Install the required gems 🔮:

```bash

bundle install

```

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

## 5. Create the database and run the migrations 🏃:

```bash

rails db:create db:migrate

```

## 6. Start the Rails server 🚀:

```bash

rails s

```

## 7. To run specs 💡:

```bash

rspec

```

## 8. Access the API in your Postman 🌐 at [http://localhost:3000](http://localhost:3000).

## Note

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