ecekpo / Budget-app

A full-stack app that allows users to signup and then see a list of houses to select with a detailed description page of the house. Users can add, delete, and add their favorite house(s). It uses a proper authentication system - JWT.

Microverse README Template

📗 Table of Contents

• 📗 Table of Contents
• 📖 [ Budget App]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 📝 License

📖 [ Budget App]

Description the project.

1. Install Ruby on Rails framework.
2. Use Ruby Gems as a software packages system.
3. Understand what ORM is.
4. Use database migration files to maintain database schema.
5. Write tests for models, controllers, system.
6. Set up associations between models.
7. Write SQL queries with Active Record
8. Use preprocessed HTML file with embedded Ruby code.
9. Use layouts and templates for shared content.
10. Build a web app that requires the user to log in.
11. Use devise gem for authentication.
12. Limit access to web app resources based on authorization rules.

🛠 Built With

Tech Stack

Client

• Rails

Server

• Rails

Database

• PostgreSQL

Key Features

• Create a budget app
• register and log in, so that the data is private to them.
• introduce new transactions associated with a category.
• see the money spent on each category.

back to top

🚀 Live Demo

• Live Demo Link

back to top

💻 Getting Started

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

1. Open terminal or cmd on you local machine and navigate to your desired directory.
2. Run 'git clone clone https://github.com/ecekpo/Budget-app.git'
3. Run 'code .'

Prerequisites

In order to run this project you need [describe prerequisites]:

 gem install rails

Setup

Clone this repository to your desired folder:

  git clone https://github.com/ecekpo/Budget-app.git
  cd Budget_app

Install

Install this project with [package manager]:

  cd Budget_app
  gem install
  rails db:migrate
  rails db:migrate RAILS_ENV=test

Usage

To run the project, execute the following command:

  rails server

(back to top)

Author

👤 Emem Ekpo

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: @LinkedIn

(back to top)

🔭 Future Features

Features of this project.

• User Authentication
• CRUD Operations

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

🙏 Acknowledgments

Original design by Gregoire Vella on Behance

⭐️ Show your support

If you like this project...

(back to top)

📝 License

This project is MIT licensed.