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 πΆ.
- Host: GitHub
- URL: https://github.com/shihabrafio/catalog-app
- Owner: shihabrafio
- License: mit
- Created: 2023-08-06T17:26:23.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-09-06T19:01:43.000Z (over 2 years ago)
- Last Synced: 2025-03-29T13:35:13.067Z (about 1 year ago)
- Topics: ruby, sql
- Language: Ruby
- Homepage:
- Size: 318 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- 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](#support)
- [π Acknowledgements](#acknowledgements)
- [β FAQ](#faq)
- [π License](#license)
**Catalog App** is an interactive digital backend app that allows you to show all items and products in a simple, visual and intuitive way.
Client
- **Add Items.**
- **Save Information into database.**
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
```
π€ **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/)
- [ ] **Add more items**
- [ ] **Add Front end**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a βοΈ if you like this project and how I managed to build it!
- 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.
- **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.
This project is [MIT](./LICENSE) licensed.