https://github.com/fatimampg/notebook-api
Ruby on Rails app (API-only) for managing contacts
https://github.com/fatimampg/notebook-api
active-model-serializers devise-token-auth json-api ruby-on-rails
Last synced: 5 months ago
JSON representation
Ruby on Rails app (API-only) for managing contacts
- Host: GitHub
- URL: https://github.com/fatimampg/notebook-api
- Owner: fatimampg
- Created: 2025-01-26T10:05:32.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-03-18T06:34:33.000Z (9 months ago)
- Last Synced: 2025-03-24T19:16:55.421Z (9 months ago)
- Topics: active-model-serializers, devise-token-auth, json-api, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 140 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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):
```bash
git clone https://github.com/fatimampg/notebook-api.git
```
- **Install dependencies:**
```bash
bundle install
```
- **Set up the database:**
```bash
rails db:create
rails db:migrate
```
- **Populate the database (Data generated using Faker gem):**
Development database:
```bash
rake dev:setup
```
Test database:
```bash
rake test_db:setup
```
- **Start server:**
Using Foreman (processes and commands defined in Procfile):
```bash
foreman start
```
Without Foreman:
```bash
rails server
```
(Available at : http://localhost:3000/)
- **List of Routes (Browser):**
Go to: http://localhost:3000/rails/info/routes
- **Run tests (RSpec):**
```bash
bundle exec rspec
```