Habits Backend

About This Project

This project is a hobby app, created to explore and demonstrate my skills and familiarity with Rails, Sidekiq, service objects, and RRule. While it showcases my abilities and understanding of the technologies used, it does not necessarily reflect the thoroughness or polish of a final production-ready application.

The primary goal of this project is to provide a playground for learning and experimentation, and as such, some areas may not be fully optimized or feature-complete. I hope it offers insight into my development process and the tools I enjoy working with.

Overview

The Habits Backend is a Rails-based API designed to deliver data for a Next.js frontend application. This project manages user to-dos, allowing them to be scheduled and set on a recurring basis using the RRule specification.

Features

• CRUD operations for tasks
• Schedule tasks with specific dates and times
• Recurring tasks using the RRule specification
• API endpoints to support Next.js frontend

Getting Started

Prerequisites

• Ruby 3.x
• Rails 6.x or 7.x
• PostgreSQL

Installation

1. Clone the repository:

   git clone https://github.com/danfrenette/habits-backend.git
   cd habits-backend

2. Install dependencies:

   bundle install

3. Set up the database:

   rails db:create
   rails db:migrate
   rails db:seed

4. Start the server:

   bin/dev

API Endpoints

api_user_tasks POST /api/users/:user_id/tasks(.:format) api/tasks#create api_users POST /api/users(.:format) api/users#create api_tasks GET /api/tasks(.:format) api/tasks#index api_task PATCH /api/tasks/:id(.:format) api/tasks#update PUT /api/tasks/:id(.:format)

• Note that some endpoints may be present in main, but are for features currently being developed for the Frontend.

Usage

This API is designed to be used with the Next.js frontend. For details on integrating with the frontend, refer to the frontend repository.

Contributing

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.

Contact

For any inquiries, send me an email yourname.