Table of contents

• Project Description
• Technologies
• Prerequisites
• Setup
• API Endpoints
• Contributing

Project Description

Moody Tracker is a mental health tracking system that facilitates awareness and reflection of moods, so users can better understand the influencing factors, and thus be able to change these to improve their mental health. For those who are already battling various mental health disorders, the system aids in their treatment process as it provides their respective therapist previous mental health data of the patient.

Technologies

• Ruby
• Ruby on Rails
• Mysql

Getting Started

Prerequisites

• ruby v2.7 and above
• rails v6 and above
• Mysql installed locally

How to Install and Run the Project

Clone the repository

git clone https://github.com/kenny-kogi/MoodyTracker-Backend.git

Change Directory

cd MoodyTracker/

Install Packages

bundle install

Usage

rails s

Open localhoost:3001 to test the available endpoints

API Endpoints

You can find all the detailed API Endpoints here https://documenter.getpostman.com/view/14668111/UyxqDjCL

Contributing

I am more than happy to collaborate with the dev community on this project. Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.