Thoth1111 / Fundsense-budget-App

A mobile web application where you can manage your budget. You have a list of transactions associated with a category, so that you can see how much money you spent and on what.

FundSense Budget App

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 FundSense Mobile Budget App

FundSense budget app is a mobile web application where a user can manage their budget. They can create a list of categories in which a list of transactions can be associated. They can also see the amounts spent or allotted to any category or transaction they own.

Watch the Video Presentation

Tech Stack

• Ruby on Rails
• PostgreSQL
• RSpec

Key Features

• User Authentication

• Active_storage for icons

• CanCanCan Authorizations

• Feature Tests

(back to top)

🚀 Live Demo

Access the deployed demo

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps:

Prerequisites

In order to run this project you need: rails, cloudinary for active_storage service.

Setup

Clone the repo and open terminal in the project root directory

Install

Install this project with:

bundle install

Create .env file in the root directory and add your database configurations and cloudinary credentials (See .env.example). If a cloudinary account is unavailable, change the config.active_storage.service value to :disk in the development environment and include this line config.active_storage.url_options = { host: 'your-production-domain.com' }. Replace your-production-domain.com with your host name.

Run rails db:create in terminal to create the database. Precompile assets by running rails assets:precompile & rails assets:clean. Execute migrations with rails db:migrate.

Usage

To run the project, execute the following command:

rails server -u webrick

(back to top)

👥 Authors

Alwyn Androvelle

• Github: @Thoth1111
• Twitter: @androvelle
• LinkedIn: @Alwyn

(back to top)

🔭 Future Features

• Implementation of all CRUD methods

• Currency option and additional finance functions

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project or find it useful, please consider giving it a ⭐️. Thanks!

(back to top)

🙏 Acknowledgments

Original design idea by Gregoire Vella on Behance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)