README.md

Budget App

Budget App is a mobile web application where users can manage their expenses and organize them in categories.

Built With

• Rails v.7.0.3
• PostgreSQL v.14.3
• Tailwind CSS for Rails
• Redis
• Sidekiq

Requirements

Install:

• Ruby v.3.1.2
• Rails v.7.0.3
• psql (PostgreSQL) v.14.3
• Redis

Getting Started

To get a local copy follow these simple example steps.

1. Open the terminal window and clone the repository using this command:
   [email protected]:leopiresgoss/budget-app.git
2. Change the directory:cd budget-app
3. Install the project's dependencies by running this command:
   bundle install
4. Make sure that PostgreSQL is running perfectly in your computer
5. Run rails db:create and then rails db:migrate to create and setup the database in PostgreSQL
6. In a separate terminal, run your Redis server, and, open another one to run the Sidekiq
7. Run ./bin/dev to start the server and run TailwindCSS, you should have three terminals opened: one for the Redis, one for the Sidekiq and the last one for this server
8. [OPTIONAL] To test the application, run rspec

Author

👤 Leonardo Pires Goss

• GitHub: leopiresgoss
• Twitter: @leonardopgoss
• LinkedIn

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• A special thank for @fernandorpm for this amazing README template
• Thanks Gregoire Vella for this outstanding template

📝 License

This project is MIT licensed.