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.
📗 Table of Contents
📖 [Catalog of my things]
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.
🛠 Built With
Tech Stack
▶ Postgresql
▶ Database
💻 Getting Started
This repository includes files with plain PostgreSQL that can be used to recreate a database:
- Use 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 should be installed in your machine.
2.) PostgreSQL
Setup
Clone this repository to your desired folder:
cd my-folder
git clone: https://github.com/Zilola-Nazarova/ruby-capstone-project.git
Install
Install the dependencies:
gem install
Usage
To run the project, execute the following command:
ruby main.rb
Run tests
To run tests, run the following command:
rspec
You can also check linter errors:
rubocop
👤 Suleiman Gacheru
- GitHub: @hetrox8
- Twitter: @suleimangacheru
👤 Zilola Nazarova
- GitHub: @Zilola-Nazarova
- Twitter: @NazarovaZi
- LinkedIn: in/NazarovaZi
👤 Essohanam Tambana
- GitHub: @GhostEsso
- Twitter: @TambanaEssohana
- LinkedIn: Tambana Essohanam
🔭 Key Features
- [OOP Implementation]
- [Proper Structure of Console App]
- [Unit Tests]
- [Documentation]
🔭 Future Features
- [Add Frontend]
- [Add Queries]
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
If you like this project kindly leave a star or follow us.
🙏 Acknowledgments
I would like to thank Microverse for giving me this wonderful opportunity to work on this project and Micronauts
📝 License
This project is MIT licensed.