Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/binhussen/catalog-of-things

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/binhussen/catalog-of-things
Owner: binhussen
License: mit
Created: 2022-11-19T06:43:51.000Z (about 2 years ago)
Default Branch: dev
Last Pushed: 2022-11-25T10:44:29.000Z (about 2 years ago)
Last Synced: 2024-11-01T12:11:55.343Z (3 months ago)
Language: Ruby
Size: 45.9 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 27
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 [Catalog of things] 

>  

**[Catalog of things]** is a third Capstone group project at Microverse.

## 🛠 Built With 

### Tech Stack 

> Database

  


    PostgreSQL

  


### Key Features 

> Describe between 1-3 key features of the application.

- **[Add items to catalog]**

- **[List items]**

(back to top)


## 💻 Getting Started 

## Project Setup

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

### Prerequisites

- You need to have Code Editor Installed

- Make sure Ruby is installed in your system 

### Setup

1. Clone the repo in your local machine:

```bash

https://github.com/binhussen/catalog-of-things

```

2. Open terminal and cd into project 

```bash

cd catalog-of-things

```

3. Command to run the files

```bash

 run main.rb

```

## 👥 Authors 

> Mention all of the collaborators of this project.

👤 **Mohammed Hussen (binhussen)**

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

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

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

👤 **Desta Legesse Wubishet**

- GitHub: https://github.com/dlwub

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

- LinkedIn: https://www.linkedin.com/in/desta-legesse-w-509844213/

👤 **Peter Njuguna**

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

- LinkedIn: [Peter Njuguna](https://www.linkedin.com/in/peter-n-3bb940122/)

(back to top)


## 🔭 Future Features 

> 

## 🤝 Contributing 

=======

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

> Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

> 

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)