SmartPocket

📗 Table of Contents

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

📖 SmartPocket

The SmartPocket keeps track of all your expences associated with catogories. It will allow you to:

• create new transactions in order keep track of your expences
• update/delete existing transactions
• create new categories in order to classify your expences by categories
• see the calculated total amount of expences per category
• update/delete existing categories

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript

Server

• Ruby
• Ruby on Rails

Database

• PostgreSQL

Key Features

• create/update/delete categories of transactions (expences)
• create/update/delete transactions (expences) associated with a category
• calculate total amount of expences for each category

(back to top)

🚀 Live Demo

• The Live Demo is available here

(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;
• Ruby on Rails 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]:Zilola-Nazarova/budget-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 npx stylelint "**/*.{css,scss}"

(OPTIONAL) For testing the confirmation emails:

gem install mailcatcher

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

(back to top)

👥 Authors

👤 Zilola Nazarova

• GitHub: @Zilola-Nazarova
• LinkedIn: in/NazarovaZi
• Twitter: @NazarovaZi

(back to top)

🔭 Future Features

• add transactions/animations
• add styles for desktop version
• improve UX/UI design

(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 just star it!

(back to top)

🙏 Acknowledgments

Original design idea by Gregoire Vella

I would like to thank the Microverse program for the knowledge and skills I have acquired in Modules 1-5.

I am grateful to all previous project reviewers for their advice. Thanks to them I could build this app.

(back to top)

📝 License

This project is MIT licensed.

(back to top)