Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/medsonmoombe/ruby-catalog-capstone
A console app that allows users to manage collections of the things they own: books, music albums, movies, and games. The data is stored in JSON files but there is also a database with the structure of tables analogical to the program's class structure.
https://github.com/medsonmoombe/ruby-catalog-capstone
rspec rubocop ruby
Last synced: 11 days ago
JSON representation
A console app that allows users to manage collections of the things they own: books, music albums, movies, and games. The data is stored in JSON files but there is also a database with the structure of tables analogical to the program's class structure.
- Host: GitHub
- URL: https://github.com/medsonmoombe/ruby-catalog-capstone
- Owner: medsonmoombe
- License: mit
- Created: 2022-08-08T18:58:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-13T09:04:57.000Z (over 2 years ago)
- Last Synced: 2023-03-04T02:14:20.680Z (almost 2 years ago)
- Topics: rspec, rubocop, ruby
- Language: Ruby
- Homepage:
- Size: 60.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ruby Group Capstone Project - Catalog of my things
In this project, we create a console app that helps to keep a record of different types of things you have won: books, music albums, movies, and games. We base our app on a UML class diagram. Data is stored in JSON files and also in a database with tables structure analogical to our program's class structure. Built with RUBY | RSPEC | RUBOCOP | PostgreSQL
Enjoy!
## Project Demo Video
[Group Project Demo Video](https://drive.google.com/file/d/1liDd-P5TjGIa2R4QMHfAqgHSjKRx7eId/view?usp=sharing)
## Built With
- Ruby
- Terminal
- IRB
- Rubocop (linters)
- TDD via RSPEC
## Getting Started
To get a local copy up and running follow these simple example steps.
## Install
In your terminal, navigate to your current directory and run this code
git clone [email protected]:medsonmoombe/Ruby-Catalog-capstone.git ruby-group-capstone
Locate the directory in your file explorer
`cd ruby-group-capstone`
Install Rubocop
`bundle install`
## Run Linters:
### To run rubocop we use:
`rubocop`
### To autocorrect offenses with rubocop we use:
`rubocop --auto-correct-all` or
`rubocop -A`
## Usage
- Navigate to the file directory `ruby-group-capstone` in your favorite terminal application
- Type in the command `ruby main.rb` to start the Catalog App
- Read through the list of options presented and type in the number of your desired action
Have fun cataloging your own 'Things' with our Ruby 'Things' Catalog Console App!
## Testing
Install the testing library 'rspec' with the following command:
`gem install rspec`
Then within the projects working directory run test using the command `rspec` in the terminal.
## Author1
👤 **Emirjeta Veisllari**
- GitHub: [@myelin0](https://github.com/myelin0)
- Twitter: [@Amy_Albania](https://twitter.com/Amy_albania)
- LinkedIn: [@Emirjeta Veisllari](https://www.linkedin.com/in/emirjeta-veisllari/)
## Author2
👤 **Emmanuel Moombe**
- GitHub: https://github.com/medsonmoombe
- Twitter: https://twitter.com/@emmanue78388405
- LinkedIn: https://www.linkedin.com/in/emmanuel-moombe-821918230/
## Author3
👤 *Stanley SIMEON*
- GitHub: [@stanleySimeon](https://github.com/stanleySimeon)
- Twitter: [@mstanleyme](https://twitter.com/mstanleyme)
- LinkedIn: [@stanleysimeon](https://www.linkedin.com/in/stanleysimeon/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/medsonmoombe/Ruby-Catalog-capstone/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc
## 📝 License
This project is [MIT](./MIT.md) licensed.