https://github.com/denscholar/catalog-of-my-things

https://github.com/denscholar/catalog-of-my-things

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/denscholar/catalog-of-my-things
• Owner: denscholar
• Created: 2022-05-02T20:17:11.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2022-05-08T00:23:14.000Z (over 2 years ago)
• Last Synced: 2024-12-16T03:08:50.564Z (27 days ago)
• Language: Ruby
• Size: 29 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 33
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# CATALOGUE-OF-MY-THINGS

## Description

In this project, we created a console app that will help us to keep records of different types of things we won: books, music albums, movies, and games. Everything will be based on the UML class diagram presented to us in the project requirement document. The data will be stored in JSON files but you will also prepare a database with tables structure analogical to our program's class structure.

## Presentation Video

[Local ideo link](video_ruby.mp4) or [google drive video link](https://drive.google.com/file/d/1CbPHqzQH8Drm2cXo3v5pO7cuv71lVdo9/view?usp=sharing)

## Getting started

To explore or play with this code you should :

- Download and install Git

- Clone the repository (desrcibed below)

### `Getting Started`

To get a local copy of this project:

Clone this repository:

   * Type in your terminal : `git clone https://github.com/denscholar/Catalog-of-my-things.git`

- Open the repository with `cd Catalog-of-my-things`

- Use your favorite Integrated Development Environment (e.g. for Visual Studio Code the command is `code .`)

- To get started, In the root directory run:

   * `gem install bundler`

   * Then run: `bundle install`

   * Then `ruby main.rb`

### Run tests

There are 2 options :

- To run All the tests:

   * Open the terminal and run `rspec . ` (please don't forget the dot after rspec)

- To run one file

   * Open the terminal and run `rspec spec spec/filename.rb`

### To track linter errors locally follow these steps:  

Track Ruby linter errors run:`rubocop`

To auto-correct Rubocop offenses run: `rubocop --auto-correct-all` 

## to run the schema.sql 

- Open PostgreSQL and create a new database

- Go to the `database` folder

- copy the content of `schema.sql" and past it to the query to tool of the pgAdmin of PostgreSQL

- then run it

## Technologies Used

- RUBY

- GitHub

- PostgreSql

## Author

*Dennis Akagha*

- GitHub: [@denscholar](https://github.com/denscholar)

- Twitter: [@denscholar](https://twitter.com/dennisakagha)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/dennisakagha/)

*Daniel Ufeli*

- GitHub: [@danielufeli](https://github.com/danielufeli)

- Twitter: [@danielufeli](https://twitter.com/danielufeli)

- LinkedIn: [LinkedIn](https://linkedin.com/in/danielcode)

*David Lafontant*

- GitHub: [@david-lafontant](https://github.com/david-lafontant)

- Twitter: [@manikatex](https://twitter.com/manikatex)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/david-lafontant/)

## Contributing

Contributions, issues, and feature requests are welcome!

## Show your support

Please give a ⭐️ if you like this project!

## Acknowledgments

- Hat tip to anyone contributed one way or the other.

- Inspiration

- etc

## License

This project is [MIT](https://github.com/microverseinc/readme-template/blob/master/MIT.md) licensed