Nkaleth / budget-app

This project is a Full Stack mobile web application built in Ruby on Rails 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.

📗 Table of Contents

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

📖 Budget-app

Budged-app is a project about building 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.

🛠 Built With

Tech Stack

Client

• Linters

Server

• ROR

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• Use database migration files to maintain database schema.
• Build a webapp that requires the user to log in.
• Use devise gem for authentication.
• Use cancancan gem for authorization.
• Follow wireframe for design.
• Deploy the app

(back to top)

🚀 Live Demo

• Live Version

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• Ruby on Rails installed and running. To get more information, read the installation guide.

• PostgreSQL installed and running

Setup

Clone this repository to your desired folder:

  git clone [e-mail]:Nkaleth/budget-app.git
  cd Recipe-app

Install

  bundle install

  npm install

  rails assets:precompile

Usage

To run the project, execute the following command:

  rake db:drop db:create db:migrate db:seed
  rails server

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Nilton Segura

• GitHub: @Nkaleth
• Twitter: @NoeSeguraL
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• Complete Desktop Version

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project feel free to fork it and use it as you need and don't forget to start it!.

(back to top)

🙏 Acknowledgments

I would like to thank Gregoire Vella for the idea of the design.

(back to top)

❓ FAQ

• Can I use the project for any purpose?

  • Yes, you can use this files for anything you need

• Do I need to ask for permission?

  • No need to ask for permission.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)