Catalog of My Things
📗 Table of Contents
- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- 📝 License
📖 [Catalog of My Things]
[Catalog of My Things] is console app built using ruby, the app will help you to keep a record of different types of things you own: books, music albums, and games, the data stored in json file, and it will be always useable whenever you start the app.
🛠 Built With
Tech Stack
- The app built using Ruby.
- The schema file built using SQL.
Key Features
The app help you to keep recods about any items you own, thing like
- [Store and Display Games]
- [Store and Display Music Albums]
- [Store and Display Books]
Video Description
In this recorder video we are describing how we built this amazing project as a team. Video
💻 Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
- Ruby should be installed in your local machine
- You need a Terminal.
- You need a code editor eg:
VsCode
Setup
Clone this repository to your desired folder:
git clone https://github.com/Abe1able/Catalog-Of-My-Things.git
cd Catalog-of-My-Things
Install
Install this project with:
cd Catalog-of-My-Things
bundle install
Usage
To run the project, execute the following command:
ruby main.rb
Run tests
To run tests, run the following command:
rspec spec
👥 Authors
👤 Botlhale Setou
- GitHub: @botlhale-setou
- Twitter: @botlhale_setou
- LinkedIn: @botlhalesetou
👤 Abel Seifu
- GitHub: Abe1able
- LinkedIn: Abel-Seifu
👤 Jacinta Ngwu
- GitHub: @JacintaNgwu
- Twitter: @jacinta_ngwu
- LinkedIn: jacinta_ngwu
🔭 Future Features
- [Searching Functionality for a specific item]
- [Provide a simple way for the user to choose from a list of options]
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
If you like this project, please give us ⭐️⭐️⭐️
🙏 Acknowledgments
We would like to acknowledge Microverse and everyone who reviewed our codes
📝 License
This project is MIT licensed.