Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/naledi-dikgale/ror-budgetapp

Last synced: 8 days ago
JSON representation

Host: GitHub
URL: https://github.com/naledi-dikgale/ror-budgetapp
Owner: Naledi-Dikgale
License: mit
Created: 2023-08-08T21:15:25.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2024-02-14T17:12:18.000Z (9 months ago)
Last Synced: 2024-02-14T18:29:04.706Z (9 months ago)
Language: Ruby
Size: 104 KB
Stars: 5
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

- [💻 Getting Started ](#-getting-started-)

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors ](#-authors-)

- [🔭 Future Features ](#-future-features-)

- [🤝 Contributing ](#-contributing-)

- [⭐️ Show your support ](#️-show-your-support-)

- [🙏 Acknowledgments ](#-acknowledgments-)

- [📝 License ](#-license-)

# 📖 ror-budgetapp  

**ror-budgetapp** is a mobile web application built using Ruby on Rails that helps users manage their spending. With this app, users can register an account and log in, ensuring that their data remains private and secure.

## 🛠 Built With 

### Tech Stack 

  


    Ruby on Rails

  


  


    PostgreSQL

  


### Key Features 

- **Splash screen.**

- **A login page.**

- **A registration page.**

- **A categories page with all the transactions that belongs to that category.**

- **A detal page with all the categories.**

(back to top)


(back to top)


## 💻 Getting Started 

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

- Create a local directory where you can clone the project

- Clone the project to your directory by running

  - `git clone https://github.com/Naledi-Dikgale/ror-budgetapp.git`

- Run the code with ruby

### Prerequisites

In order to run this project you need:

- Git and GitHub

- A code editor

- Ruby on rails

### Setup

Clone this repository to your desired folder:

- Create a local directory where you can clone the project

- Clone the project to your directory by running

  - `git clone https://github.com/Naledi-Dikgale/ror-budgetapp.git`

### Install

Install this project with:

```sh

  cd my-project

  gem install

  rails db:create

  rails db:migrate

```

### Usage

To run the project, execute the following command:

```sh

  rails server

```

### Run tests

To run tests, run the following command: Install through : gem install rspec

```sh

  rspec

```

👤 **Author1**

 *[NALEDI DIKGALE]*

 

- GitHub: [@githubhandle](https://github.com/Naledi-Dikgale)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/naledi-dikgale-068423159/)

- Website: [@naledi_Dikgale](https://nalediportfolio.netlify.app/)

(back to top)


## 🔭 Future Features 

- [ ] **Add edit and delete functionality.**

- [ ] **Improve the styling.**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Naledi-Dikgale/ror-budgetapp/issues).

(back to top)


## ⭐️ Show your support 

If you like this project kindly leave a ⭐

(back to top)


## 🙏 Acknowledgments 

I would like to thank [Gregoire Vella](https://www.behance.net/gregoirevella)  for this beautiful design and Microverse for the great resources shared.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)