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

https://github.com/iamyunusali/birre

Birre is a full-stack web Application that is developed using Ruby on Rails and tailwind CSS. It has the functionality of creating and signing up for accounts. having categories of items and transactions in each category.
https://github.com/iamyunusali/birre

ruby ruby-on-rails rubyonrails tailwindcss taiwindcss

Last synced: about 2 months ago
JSON representation

Birre is a full-stack web Application that is developed using Ruby on Rails and tailwind CSS. It has the functionality of creating and signing up for accounts. having categories of items and transactions in each category.

Awesome Lists containing this project

README

          

logo

Birre app

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 [Birre APP]

>
**[Birre app]** is a birre manager website.

## 🛠 Built With

### Tech Stack

> Describe the tech stack and include only the relevant sections that apply to your project.

Client

Server | Backend

Database

### Key Features

> Describe between 1-3 key features of the application.

- **[Add Category and transaction]**
- Interact with category and transaction
- **[Sign in and sign up]**
- User authentication. Set birre to either public or private.

(back to top)

## 🚀 Live Demo

> Add a link to your deployed project.

- [Live Demo Link](https://birre-app.onrender.com/)

(back to top)

## 💻 Getting Started

> Describe how a new developer could make use of your project.

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

### Prerequisites

In order to run this project you need:

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
cd birre
git clone https://github.com/IamYunusAli/Birre.git
cd birre
Open in your favorite editor
```

### Install

Install this project with:

```sh
cd birre
gem install
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
bin/rspec spec
```

### Deployment

You can deploy this project using:

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **Yunus Ali**

- GitHub: [@IamYunusALi](https://github.com/iamyunusali)
- Twitter: [@IamYunusAli](https://twitter.com/iamyunusali)
- LinkedIn: [Yunus Ali](https://linkedin.com/in/iamyunusali)

(back to top)

## 🔭 Future Features

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

- [ ] **[Edit category]**
- [ ] **[Delete Category ]**
- [ ] **[list animation]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project

If you like this project...

(back to top)

## 🙏 Acknowledgments

> Give credit to everyone who inspired your codebase.
I would like to thank...
> Original design idea by [Gregoire Vella on Behance.](https://www.behance.net/gregoirevella)

> the design [Design here](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=)

(back to top)

## ❓ FAQ

> Add at least 2 questions new developers would ask when they decide to use your project.

- **[Question_1]**

- [Answer_1]

- **[Question_2]**

- [Answer_2]

(back to top)

## 📝 License

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

(back to top)