RoyJumah / catalog-of-my-things

This project involves creating a media cataloging system with a user interface and a database schema for storing data.

📗 Table of Contents

• 📗 Table of Contents
• 📖 my-catalog
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Run tests
    • Video walkthrough
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Catalog of my things

• This project involves creating a media cataloging system with a user interface and a database schema for storing data.

(back to top)

🛠 Built With

Tech Stack

• Ruby
• RSpec

Key Features

• Media cataloging system.
• User-friendly interface.
• Data storage in JSON.

(back to top)

💻 Getting Started

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.

Setup

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

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

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

 cd <folder/catalog-of-my-things>

If VsCode is your default code editor, run:

  code .

To install the existing dependecies,run:

  bundle install

And finally if you want to have fun by entering data into the application, run ruby main.rb and you will be provided with a list of what you can do

You are all set up!

(back to top)

Run tests

To run tests, run the following command:

  $ rspec --force-color --format documentation

(back to top)

Video Walkthrough

• The link to the video discussing about our application and its interesting features!

(back to top)

👥 Authors

👤 Roy Jumah

• GitHub: @RoyJumah
• Twitter: @_royissues
• LinkedIn: Roy Jumah

👤 Hassaan Baig

• GitHub: @hassanBaig
• LinkedIn: hassanBaig

👤 Kennedy Owusu

• GitHub: @kennedyowusu
• Twitter: @_iamkobby
• LinkedIn: @kennedyowusu

(back to top)

🔭 Future Features

• Search and filter media
• Add/edit media properties
• User authetication and permissions
• Integration with external APIs
• And all of this will be built in a beautiful and well-organized way!

(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 you can give it a star

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for providing us the resources that enabled us to finish this challenge!

(back to top)

📝 License

This project is MIT licensed.

(back to top)