NOTEBOOK - Contact management API

Ruby on Rails API

Rails version: 8.0.1
Database: SQLite (configured in config/database.yml)
JSON:API: Uses ActiveModel::Serializer for serialization
Authentication: Uses Devise Token Auth

Set up:

Clone repository (HTTPS):

git clone https://github.com/fatimampg/notebook-api.git

Install dependencies:

bundle install

Set up the database:

rails db:create
rails db:migrate

Populate the database (Data generated using Faker gem):

Development database:

rake dev:setup

Test database:

rake test_db:setup

Start server:

Using Foreman (processes and commands defined in Procfile):

foreman start

Without Foreman:

rails server

(Available at : http://localhost:3000/)

List of Routes (Browser):
Go to: http://localhost:3000/rails/info/routes
Run tests (RSpec):

bundle exec rspec