Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/baayeh/cruiseware

The inventory management service
https://github.com/baayeh/cruiseware

Last synced: 8 days ago
JSON representation

The inventory management service

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)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [📝 License](#license)

# 📖 CRUISE WARE

**Cruise Ware** is the warehouse/inventory management service for Cruise.

## 🛠 Built With

### Tech Stack

Client

### Key Features

- **Managing inventories**
- **Managing roles and permissions**
- **Managing action-entities**
- **Managing inventory inbounds**
- **Managing inventory outbounds**
- **Reporting and analytics**

(back to top)

## 🚀 Live Demo

- [Video Presentation](https://drive.google.com/file/d/1tx9LmQIedSSM3OMM0S2f26Bgm4f8nC1a/view?usp=sharing)

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

- Latest version of Node
- Git installed

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/Codart-7/CruiseWare.git
```

### Install

Install this project with:

```sh
cd CruiseWare/frontend
npm install
```

### Usage

To run the project, execute the following command:

```sh
npm run dev
```

(back to top)

## 👥 Authors

👤 **Michael Adisa**

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

👤 **Omopariola Emmanuel**

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

👤 **Kwasi Baayeh**

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

(back to top)

## 🔭 Future Features

- [ ] **[new_feature_1]**
- [ ] **[new_feature_2]**
- [ ] **[new_feature_3]**

(back to top)