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

https://github.com/shihabrafio/catalog-app

Discover the ultimate organizational solution for your personal collections with the Catalog of My Things App. This user-friendly application offers a seamless and intuitive experience, allowing you to effortlessly manage and explore various categories of your belongings, including games, books πŸ“š, and music albums 🎢.
https://github.com/shihabrafio/catalog-app

ruby sql

Last synced: 12 months ago
JSON representation

Discover the ultimate organizational solution for your personal collections with the Catalog of My Things App. This user-friendly application offers a seamless and intuitive experience, allowing you to effortlessly manage and explore various categories of your belongings, including games, books πŸ“š, and music albums 🎢.

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](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [πŸ“ License](#license)

# πŸ“– Catalog App

**Catalog App** is an interactive digital backend app that allows you to show all items and products in a simple, visual and intuitive way.

## πŸ›  Built With

### Tech Stack

Client

### Key Features

- **Add Items.**
- **Save Information into database.**

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

- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).

### Setup

Clone this repository to your desired folder or download the Zip folder:

```
git clone https://github.com/shihabrafio/Catalog-App.git
```

- Navigate to the location of the folder in your machine:

**``you@your-Pc-name:~$ cd Catalog-App``**

### Install

To install all dependencies, run:

```
bundle install
```

### Usage

To run the project, follow these instructions:

- After Cloning this repo to your local machine.
- To get it running in your terminal, run it in your IDE

### Run tests

To run tests, run the following command:

- To run Linter Tests, run:

```
rubocop
```

- To run Unit Tests, run:
```
rspec
```

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Gakii Beryl**

- GitHub: [@berylcl](https://github.com/berylcl)
- Twitter: [omg_its_beryl](https://twitter.com/omg_its_beryl)
- LinkedIn: [gakii](https://www.linkedin.com/in/gakii-beryl/)

πŸ‘€ **A.I.M. Shihab Uddin Khan**

- GitHub: [@shihabrafio](https://github.com/shihabrafio)
- LinkedIn: [Shihab Uddin Khan](https://www.linkedin.com/in/shihab-uddin-khan-45620a16a/)

πŸ‘€ **Foga Kater Amos**

- GitHub: [@githubhandle](https://github.com/katfogy)
- Twitter: [@twitterhandle](https://twitter.com/Katfogy)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/foga-amos-2b5371103/)

(back to top)

## πŸ”­ Future Features

- [ ] **Add more items**
- [ ] **Add Front end**

(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

Give a ⭐️ if you like this project and how I managed to build it!

(back to top)

## πŸ™ Acknowledgments

- The original design ideal from MicroverseπŸ’•.
- Project from [Microverse](https://bit.ly/MicroverseTN) Ruby / Database and Interviewing module.
- Thanks to the Microverse team for the great curriculum.
- Thanks to the Code Reviewer(s) for the insightful feedbacks.
- A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
- Hat tip to anyone whose code was used.

(back to top)

## ❓ FAQ

- **Can I fork and reuse the repository**

- Yes please, feel free.

- **Can I improve the repository, and my changes will be accepted if they are good?**

- Yes please, nice ideas are welcome, please.

(back to top)

## πŸ“ License

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

(back to top)