https://github.com/eimaam/unimaid-marketplace

Building.... 💡
https://github.com/eimaam/unimaid-marketplace

Last synced: 20 days ago
JSON representation

Building.... 💡

• Host: GitHub
• URL: https://github.com/eimaam/unimaid-marketplace
• Owner: eimaam
• Created: 2022-11-18T14:14:17.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-08T18:07:55.000Z (almost 2 years ago)
• Last Synced: 2024-12-06T05:52:32.438Z (28 days ago)
• Language: JavaScript
• Homepage: unimaid-marketplace.vercel.app
• Size: 6.3 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  

  


  


    Maid Marketplace

  




# 📗 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 (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 [Unimaid Marketplace - Campus Sales Platform] 

**[Unimaid Marketplace]** is a fullstack application built purposely to ease the buying and selling in University/Campus. It is built in a way to easily connect sellers to their client/buyers by posting free ads in an easy to use environment.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
 React.js 

  

  


    
 SASS 

  

  


    
 JavaScript 

  


  Server

  


    
Firebase

  


Database

  


    
FireStore

  


### Key Features 

- **Account Management**

- **Free Registration**

- **Free Sell Ads Posting**

- **Seller Profile/Account Management**

- **Ad Management**

- **Ad Push**

- **Seller Profile**

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://maidmarketplace.vercel.app)

(back to top)


## 💻 Getting Started 

> Describe how a new developer could make use of your project.

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

### Prerequisites

In order to run this project you need:

- Google Firebase Account

- Editor with Terminal 

### Setup

- Clone or Fork this Repo

- Download to your local machine 

- Unzip the Folder 

- Launch with your preferred Editor preferrably VS Code 

- Open terminal in Project root location 

### Install

Run the below command in the project root directory to install all dependencies:

```sh

  npm install 

```

### Usage

To run the project, execute the following command:

```sh

  npm run start

```

### Deployment

You can deploy this project to Vercel:

(back to top)


(back to top)


## 🔭 Future Features 

> Describe 1 - 3 features you will add to the project.

- [ ] **Payment Gateway for processing Payment on Site**

- [ ] **Chat Management directly from Website**

- [ ] **Widen Usage to More Institutes and adding more categories**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


If you like this project give me a shout out on Twitter (@eimaam_d) or LinkedIn (Imam Dahir Dan-Azumi)

(back to top)


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