Code Monkey home page Code Monkey logo

budgetapp's Introduction

๐Ÿ“— Table of Contents

๐Ÿ“– [MY BUDGET]

This app is 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. [MY BUDGET] is a mobile application coding with Ruby on Rails!

๐Ÿ›  Built With

Tech Stack

Client
Server
Database

Key Features

  • **Custom categories for each user
  • **Transactions are displayed to show the balance of money
  • **Display their expenditure on each category

(back to top)

live demo

live

๐Ÿš€ video

video

(back to top)

๐Ÿ’ป Getting Started

Prerequisites

Check your Ruby version or install it

ruby --version && irb

The ouput should start with something like ruby 3.1.2

If not, install the right ruby version using rbenv (it could take a while):

rbenv install 3.1.2

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

Clone the repository

git clone https://github.com/tamana-Balkhi/BudgetApp.git
cd blog-app-ror

Install

  • Ensure you have PostgreSQL installed before running the application psql --version
  • Run bundle install
  • Create a .env file in the project's root folder to assign variable values for the psql database (linked to the config/database.yml)
  • Run rails db:create and then rails db:migrate
  • Run rails server
  • Open Browser http://localhost:3000/

.env File Structure

This is the intended file content for the .env file:

# ./env
POSTGRES_HOST='localhost'
POSTGRES_USER='postgres'
# If you declared a password when creating the database:
POSTGRES_PASSWORD='a'

# POSTGRES_HOST='localhost'
# dbs
POSTGRES_DEV_DB='my_budget'
POSTGRES_TEST_DB='my_budget_test'
POSTGRES_PROD_DB='my_budget_prod'
# PROD_PASSWORD = 'production_password'
# 

Replacing the variable values where needed (most importantly `username` and `password`)

### Usage

To run the project, execute the following command:

```sh
  rails server

Testing

To test and utilize the code, use the terminal and run ruby by inputting irb in the command line, or by using an extension in Visual Studio Code like Code runner

The user then can modify and play with the files as needed

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Tamana Balkhi

(back to top)

๐Ÿ”ญ Future Features

  • Validations and Model specs
  • Setup and controllers
  • Views and Forms

(back to top)

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

Give a โญ๏ธ if you like this project!

(back to top)

๐Ÿ™ Acknowledgments

Original design idea by Gregoire Vella on Behance

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

budgetapp's People

Contributors

tamana-balkhi avatar

Stargazers

 avatar Sanam Rahimi avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.