Giter Club home page Giter Club logo

catalog-of-my-things's Introduction

catalog-of-my-things

๐Ÿ“— Table of Contents

๐Ÿ“– [catalog-of-my-things]

[catalog-of-my-things] Is a console app that helps keep records of different types of things: books, music albums, and games.The data is stored in JSON files. A database with tables structure analogical to the program's class structure is prepared.

๐Ÿ›  Built With

Tech Stack

Ruby
  • https://www.ruby-lang.org/en/

Key Features

  • [Class functionality]

(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:

 bundle install

Setup

Clone this repository to your desired folder:

  cd catalog-of-my-things
  git clone https://github.com/Naledi-Dikgale/catalog-of-my-things.git

Install

Install this project with:

  cd catalog-of-my-things
  bundle install
  gem install --no-document rubocop -v '>= 1.0, < 2.0'
  gem install rspec

Usage

To run the project, execute the following command:

  ruby main.rb
  or
  ./main

Run tests

To run tests, run the following command:

  • rubocop --color
  • rspec spec --format doc

Deployment

  • Project is not deployed

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Author1 [NALEDI DIKGALE]

๐Ÿ‘ค Author2 [NDONYI MAURICE]

๐Ÿ‘ค Author3 [PATRIC MUKULA]

๐Ÿ”ญ Future Features

  • [Add different structure]

(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 please show support by staring โญ๏ธ.

(back to top)

๐Ÿ™ Acknowledgments

  • We would like to thank Microverse for accommodating us in the Full-time Software Development program

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

catalog-of-my-things's People

Contributors

citec-47 avatar naledi-dikgale avatar patfarmurs avatar

Stargazers

 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.