m-aminalizadeh / budget-app

📗 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]

[Budget-app] is a app specially designed for mobile devices and let users to track there transaction on specific categories.

For more info just check this video

🛠 Built With

Tech Stack

Client

• Bootstrap

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• [Easy usage]
• [Responsive]

(back to top)

🚀 Live Demo

• Live Demo Link

(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:

• GitHub account;
• Git installed on your OS;
• VSCode (or another code editor);
• modern browser (supporting HTML5 and CSS3) is highly recommended;
• Ruby installed;
• Node.js and npm installed.

Setup

Clone this repository to your desired folder:

Login to your GitHub account. Clone this repository to your desired folder:

cd my-folder git clone [email protected]:M-AminAlizadeh/Recipe-app.git

Setup database:

sudo -u postgres createuser --interactive --pwprompt (provide the username and password described in config/database.yml)

Install

Install the dependencies:

gem install npm install

Create database:

bin/rails db:create

(OPTIONAL) Fill the database with sample records:

bin/rails db:seed

Usage

To run the server:

rails server

Open http://localhost:3000 to view it in your browser.

Run tests

To run tests, run the following command:

rspec

You can also check linter errors by running these commands:

rubocop

For testing the confirmation emails:

gem install mailcatcher

Open http://localhost:1080 to view it in your browser.

(back to top)

👥 Authors

👤 Amin Alizadeh

• GitHub: @M-AminAlizadeh
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

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

• [Desktop version]
• [Add all CRUD to categories & transactions]
• [Tag]

(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, Give it a star, and check out more of our work.

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for Providing such a motivating and wonderfully diverse learning environment.

(back to top)

📝 License

This project is MIT licensed.

(back to top)