Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zilola-nazarova/ruby-capstone-project
A console app that allows users to manage collections of their things: books, music albums, and games. The data is be stored in JSON files. Built with Ruby.
https://github.com/zilola-nazarova/ruby-capstone-project
console-app rspec ruby
Last synced: 27 days ago
JSON representation
A console app that allows users to manage collections of their things: books, music albums, and games. The data is be stored in JSON files. Built with Ruby.
- Host: GitHub
- URL: https://github.com/zilola-nazarova/ruby-capstone-project
- Owner: Zilola-Nazarova
- Created: 2023-10-16T12:36:14.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-10-19T18:21:58.000Z (over 1 year ago)
- Last Synced: 2025-01-01T14:39:37.648Z (about 1 month ago)
- Topics: console-app, rspec, ruby
- Language: Ruby
- Homepage:
- Size: 206 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Catalog_of_My_Things\] ](#-Catalog_of_My_Things-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)The "Catalog of My Things" is a console-based application built using Ruby as the backend technology. This application offers a straightforward user interface to organize and manage different categories of personal belongings or items.
Ruby
▶ Database
This repository includes files with plain PostgreSQL that can be used to recreate a database:
- Use [schema.sql](./database/schema.sql) to create all tables
- Find the visual representatio of the database inside the folder :
### Prerequisites
In order to run this project, you must have installed and configured the following tools in your local environment:
1). Ruby
- the [Ruby](https://www.ruby-lang.org/en/ownload/) should be installed in your machine.
2.) PostgreSQL
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone: https://github.com/Zilola-Nazarova/ruby-capstone-project.git
```
### Install
Install the dependencies:
```sh
gem install
```
### Usage
To run the project, execute the following command:
```sh
ruby main.rb
```
### Run tests
To run tests, run the following command:
```sh
rspec
```
You can also check linter errors:
```sh
rubocop
```
👤 **Suleiman Gacheru**
- GitHub: [@hetrox8](https://github.com/hetrox8)
- Twitter: [@suleimangacheru](https://twitter.com/suleimangacheru)
👤 **Zilola Nazarova**
- GitHub: [@Zilola-Nazarova](https://github.com/Zilola-Nazarova)
- Twitter: [@NazarovaZi](https://twitter.com/NazarovaZi)
- LinkedIn: [in/NazarovaZi](https://www.linkedin.com/in/zilola-nazarova)
👤 **Essohanam Tambana**
- GitHub: [@GhostEsso](https://github.com/GhostEsso)
- Twitter: [@TambanaEssohana](https://twitter.com/TambanaEssohana)
- LinkedIn: [Tambana Essohanam](https://www.linkedin.com/in/essohanam-tambana-62aa081a1/)
- [ ] **[OOP Implementation]**
- [ ] **[Proper Structure of Console App]**
- [ ] **[Unit Tests]**
- [ ] **[Documentation]**
- [ ] **[Add Frontend]**
- [ ] **[Add Queries]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project kindly leave a star or follow us.
I would like to thank Microverse for giving me this wonderful opportunity to work on this project and Micronauts
This project is [MIT](./MIT.md) licensed.