Skip to content

Latest commit

 

History

History
168 lines (108 loc) · 4.43 KB

README.md

File metadata and controls

168 lines (108 loc) · 4.43 KB

📗 Table of Contents

📖 Catalog App

Catalog App is an interactive digital backend app that allows you to show all items and products in a simple, visual and intuitive way.

🛠 Built With

Tech Stack

Client

Key Features

  • Add Items.
  • Save Information into database.

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

Setup

Clone this repository to your desired folder or download the Zip folder:

git clone https://github.com/AdnanOlarmmi/Catalog-App.git
  • Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd Catalog-App

Install

To install all dependencies, run:

bundle install

Usage

To run the project, follow these instructions:

  • After Cloning this repo to your local machine.
  • To get it running in your terminal, run it in your IDE

Run tests

To run tests, run the following command:

  • To run Linter Tests, run:
rubocop
  • To run Unit Tests, run:
rspec

(back to top)

👥 Authors

👤 Is-haq, Adnan Olamilekan

👤 Ahmed Nazir Musah

👤 Joel Kugonza

(back to top)

🔭 Future Features

  • Add more items
  • Add Front end

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project and how I managed to build it!

(back to top)

🙏 Acknowledgments

  • The original design ideal from Microverse💕.
  • Project from Microverse Ruby / Database and Interviewing module.
  • Thanks to the Microverse team for the great curriculum.
  • Thanks to the Code Reviewer(s) for the insightful feedbacks.
  • A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
  • Hat tip to anyone whose code was used.

(back to top)

❓ FAQ

  • Can I fork and reuse the repository

    • Yes please, feel free.
  • Can I improve the repository, and my changes will be accepted if they are good?

    • Yes please, nice ideas are welcome, please.

(back to top)

📝 License

This project is MIT licensed.

(back to top)