README.md

Welcome

Hi! I'm Pedro and I've developed this API for learning purposes. The API is a small Ruby on Rails application which lets you:

1. User authentication (sign up, sign in, etc)
2. User management (get profile, update it...)
3. Add expenses by user

It also handles:

• Model validations
• Tracking model instaces modifications
• Payments webhooks from different payment processors

TODOs:

• Add Apipie for endpoints documentation
• Add rake task to build openapi.yml from Apipie integration

And of course. TESTS

Setup

Let's start by setting up the app.

Clone the repo

git clone git@github.com:devfviak/factorial_api.git

Install dependencies

bundle install

Make sure you have Mysql installed and create your own database.yml file. (Follow the database.yml.example in the project)

touch /config/database.yml

Setup env variables. Create an .env file in project root folder with the following content: 
 

DB_USERNAME='your_mysql_db_user'
DB_PASSWORD='your_mysql_db_passwrd'

API_URL='http://localhost:3000'
FRONTEND_URL = 'http://localhost:5173'

Setup database

rails db:setup

Run it

Once setup is done, you can start the server

rails s