Control+ is a personal financial management tool in Portuguese. It provides users with a straightforward and responsive platform to manage their tasks and finances.
-
Task management:
- Create, edit, and delete tasks.
- Mark tasks as done or unmark them.
- Rearrange tasks using a mouse or fingers on the task list page.
- Search for specific tasks with the search bar.
- Task entries contain a description, date, and time.
-
Financial management:
- Manage receivables (entradas) and payables (saídas).
- Search for finance entries with a search bar.
- Create, edit, and delete financial entries.
- Separate pages for receivables and payables, each with its own entries.
- Displays for the total of receivables or payables and the overall total (receivables - payables).
- Visual cues for the user's financial status (black for positive balance, blinking red for negative balance).
-
Fully responsive design for tablets and mobile devices.
This was the capstone project during Le Wagon São Paulo's bootcamp, between July and September 2022. The authors' info can be found below.
What users see when not logged in
What users see when logged in
This web application can be accessed directly at https://controlplus.pro. If you want to set up the project locally or contribute to its development, follow these steps:
- Ruby 3.1.2
- Rails 7.0.3.1
- Node.js 16.x.x
- Yarn 1.22.19
- PostgreSQL
- Cloudinary account and credentials for image hosting
In addition to the prerequisites, you'll need to install the following external libraries or packages:
- Devise
- Simple Form
- Stimulus version 3.1.0
- @hotwired/turbo-rails version 7.1.3
- Bootstrap version 5.2.0
- Popper.js version 2.11.6
- Sortable.js version 1.15.0
- Sweetalert version 2.1.2
- Sweetalert2 version 11.4.32
- Typed.js version 2.0.12
- Webpack version 5.74.0
- Webpack-cli version 4.10.0
No additional configuration is needed beyond the standard Rails configuration.
To run the project locally, follow these steps:
- Clone the repository to your local machine:
git clone https://github.com/your_username/your_project.git - Change into the project directory:
cd your_project - Install the required Ruby gems:
bundle install - Install the required JavaScript packages:
yarn install - Set up the database:
rails db:create db:migrate db:seed - Start the development server:
rails s
Now you can access the application in your web browser at http://localhost:3000
The project is deployed to Heroku. To deploy your own version of the project, follow these steps:
-
Install the Heroku CLI and log in with your Heroku account:
heroku login -
Create a new Heroku app:
heroku create your-app-name -
Set up your app's environment variables in Heroku:
heroku config:set RAILS_MASTER_KEY=`cat config/master.key` -
Deploy your app to Heroku:
git push heroku main -
Run database migrations on Heroku:
heroku run rails db:migrate
Your application should now be live on Heroku.
If you encounter any issues, please refer to the Heroku documentation for more information.
To use Control+, simply log in with your account credentials or create a new account. Once you are logged in, you can create, edit, and delete tasks and financial entries, as well as view your receivables and payables.
If you'd like a step-by-step guide, you can find one here.
If you want to contribute to Control+, please fork the repository and make your changes. When you are ready to submit your changes, create a pull request with a detailed description of the changes you made.
Control+ was created by Rafael Kasinski, Suzane Andrade, and Gabriel Soares during the Le Wagon São Paulo bootcamp, between July and September 2022. Further contributions were made by Fabian Carlos
Control+ is open source software licensed under the MIT License