🚀 Rails API Starter

A lightweight, RESTful Rails API built with Ruby on Rails, designed to be used as a backend for web or mobile applications.

📦 Features

• Ruby on Rails API mode (no views, no frontend)
• RESTful JSON endpoints
• CORS enabled
• PostgreSQL (or your preferred DB)
• RSpec
• Environment-based configurations
• Token-based authentication (optional, if included)

🛠️ Setup Instructions

Prerequisites

• Ruby (version 3.4.4)
• Rails (version 8.0.2)
• PostgreSQL or SQLite (update accordingly)
• Node.js and Yarn (for managing frontend dependencies, if needed)

Getting Started

# Clone the repo
git clone https://github.com/your-username/portfolio_api.git
cd portfolio_api

# Install dependencies
bundle install

# Setup database
rails db:create db:migrate

# Run the server
rails s

🌐 API Documentation

Coming soon...

🚧 TODOs

• Add authentication (e.g. JWT or Devise)
• Add more endpoints
• Setup CI/CD (e.g. GitHub Actions)
• Deploy

📄 License

This project is licensed under the MIT License.

✍️ Author

Rajal Kumar – @rajal-kumar

Feel free to reach out if you have questions or suggestions!