Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leboroz/catalog-of-my-things
https://github.com/leboroz/catalog-of-my-things
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/leboroz/catalog-of-my-things
- Owner: Leboroz
- Created: 2022-04-18T15:22:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-04-23T02:42:55.000Z (over 2 years ago)
- Last Synced: 2023-03-08T18:04:10.378Z (over 1 year ago)
- Language: Ruby
- Size: 74.2 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Catalog of my things
> In this project, we created a console app that helps you keeping
a record of different types of things you won: books, music albums, movies,
and games. Everything will be based on the UML class diagram presented below.
The data will be stored in JSON files but we also prepared a database with
tables structure analogical to your program's class structure.
## Built With
- Ruby
- Rspec, Rspec utils
- Git, Gitflow
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- Git
- Ruby
### Setup
- run
```bash
$ git clone [email protected]:Leboroz/catalog-of-my-things.git
$ cd catalog-of-my-things
```
### Install
- run
```bash
$ bundle install
```
> this will install all the packages necessaries to run the app and tests
### Usage
- run
```bash
$ ruby main.rb
```
The console app, at the start, should:
- Present the user with a list of options to perform.
- Let users choose an option.
- If needed, ask for parameters for the option.
- Have a way to quit the app.
- The following options are available:
- List all books
- List all music albums
- List all movies
- List of games
- List all genres (e.g 'Comedy', 'Thriller')
- List all labels (e.g. 'Gift', 'New')
- List all authors (e.g. 'Stephen King')
- List all sources (e.g. 'From a friend', 'Online shop')
- Add a book
- Add a music album
- Add a movie
- Add a game
### Run tests
run
```bash
$ rspec
```
## Authors
👤 **Lisandro Seia**
- **GitHub** [@lisandroseia](https://github.com/lisandroseia)
- **LinkdIn** [LinkedIn](https://www.linkedin.com/in/lisandro-seia-295120225/)
👤 **Leonardo Albornoz**
- **GitHub** [@Leboroz](https://github.com/leboroz)
- **Twitter** [@Leboroz](https://twitter.com/leboroz)
- **LinkedIn** [Leonardo Albornoz](https://linkedin.com/in/leboroz)
👤 **Nicolas Gonzalez**
- **GitHub** [@Nicolaswg](https://github.com/Nicolaswg)
- **LinkdIn** [LinkedIn](https://www.linkedin.com/in/nicolas-gonzalez-8623461a0/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/leboroz/catalog-of-my-things/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.