Javivy / budget-app

Budget App README

📗 Table of Contents

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

📖 Budget App

Lear more about this project below

Budget App is a server side rendered application following MVC architecture, 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 on what.

🛠 Built With

Tech Stack

Would you like to know about tools and Tech I have used?

Client

• HTML
• CSS
• Tailwind CSS
• JavaScript(for navigation bar)
• Icons: ionicons
• Google Fonts for: Montserrat(300 and 700)

Server

• tailwindcss-rails
• Devise (for authentication)
• Render (for deployment)
• Ruby On Rails

Database

• PostgreSQL

Test

• RSpec
• Capybara
• selenium-webdriver

Key Features

take a look below:

• User can add a transaction for given category
• User can add a category
• User can select one of 6 icons for ther categories
• User can see transactions for a given category

(back to top)

🚀 Live Demo

If you would like to see this site on action click on the link below:

• Live Demo Link

(back to top)

💻 Getting Started

Would you like to make use of this project?

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

Prerequisites

In order to run this project you need to have installed Ruby 3.2.2 and then install rails if yo don't have it yet:

 gem install rails

Setup

to clone the repo, on your terminal access to your desired folder:

cd my-folder

Then clone the project:

  cd my-folder
  git clone [e-mail]:Diegogagan2587/budget-app.git

Install

Install this project with the following instructions:

Access to the folder you just have cloned:

cd budget-app

install all required gems:

  gem install

Usage

To run the project, execute the following command:

  rails server

if you are not able to see the style in your local server open another terminal and run:

  rails tailwindcss:watch

the previous command will watch for you styling and then you should be able to see in in your browser.

Run tests

To run tests, run the following command:

  rspec

Deployment

You can deploy this project using render, check out docs below:

deployment with render

(back to top)

👥 Authors

Would you like to get in touch?

👤 Diego Vidal Lopez

• GitHub: @Diegogagan2587
• Twitter: @dieg02587
• LinkedIn: Diego Vidal Lopez

(back to top)

🔭 Future Features

Some feature I might implement in the future:

• Account Confirmation and recovery
• Edit or update transactions or categories
• Implement a proper design for desktop browsers

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Would you like to support?

If you like this project you are free for get your own copy, as well feel free to let me know any problem in the issues page.

(back to top)

🙏 Acknowledgments

I would like to thank to the youtube channel Code A program for providing the initial template for the Navigation.

Original design idea by Gregoire Vella on Behance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)