Giter VIP home page Giter VIP logo

elarhadu / catalog-of-my-things Goto Github PK

View Code? Open in Web Editor NEW

This project forked from leehaney254/catalog-of-my-things

2.0 0.0 0.0 161 KB

In this project, my partners Leehaney ,Yuvenal and I created a console app that helps users to keep a record of different types of things they own: books, music albums, movies, and games. Everything is based on the UML class diagram presented below. The data will be stored in JSON files.

License: MIT License

Ruby 100.00%

catalog-of-my-things's Introduction

Catalog Of My Things


๐Ÿ“— Table of Contents

๐Ÿ“– Catalog Of My Things

In this project, my partners Elarh,Yuvenal and I created a console app that helps users to keep a record of different types of things they own: books, music albums, movies, and games. Everything is based on the UML class diagram presented below. The data will be stored in JSON files.

๐Ÿ›  Built With

Tech Stack

Server
Database

Key Features

  • Add a Book
  • Add a Game
  • Create and manage data about my things
  • Add a Music Album
  • List all added items
  • Keep track of books, music albums, movies, and games and other information

(back to top)

LIVE DEMO

๐Ÿš€ Demo Video

Please visit our zoom video presentation. Click the Link button.

UML Diagram

diagram

(back to top)

๐Ÿ’ป Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

  • To install ruby in your PC. You can read this documentation on how to do so
  • Know how to navigate directories or folders at the CLI.
  • Know how to get the URL(https/ssh) of a repository on GitHub.
  • You should have a code editor installed, preferably VSCode.
  • In order to run this project you need:

Setup

In desired folder or directory in the CLI, run the command:

git clone [email protected]:leehaney254/Catalog-of-my-things.git

Navigate into the cloned folder or repository by running the command:

cd Catalog-of-my-things

If VsCode is your default code editor, run:

code .

You are all set up!

Install

Install this project with:

 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 spec/[filename.rb]

(back to top)

๐Ÿ‘ฅ Author

๐Ÿ‘ค Leehaney George

๐Ÿ‘ค Emmanuella Adu

๐Ÿ‘ค Yuvenal Njoroge

(back to top)

๐Ÿ”ญ Future Features

Integration with PostgreSQL

(back to top)

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

If you like this project give us โญ

(back to top)

๐Ÿ™ Acknowledgments

I would like to thank Microverse for this project inspiration.

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

catalog-of-my-things's People

Contributors

leehaney254 avatar elarhadu avatar yuvenalmash avatar

Stargazers

 avatar HOUDA MZARI avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.