Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.5 KB

README.md

File metadata and controls

39 lines (24 loc) · 1.5 KB

El-Marchi

"El-Marchi" ( means The Market in Tunsian Arabic Dialect ) is an E-commerce platform dedicated for everything related to trade.

El-Marchi includes:

  • an E-commerce Platform equivalent to an online Bazzar. ( yess bargain is possible )
  • a map showcasing your local markets, malls and Bazzars, each with its own speciality.
  • an event management platform dedicated to manage events such as sale seasons, exhibitions, fairs, auctions, and other trade related big events.
  • online auction system.

Of course for now this is only a projection on what we imagine this platform to be.

Project Strucutre

This a monorepo consisting of two parts: the UI and the API both powered by Nx.

It is built using Nestjs, Angular 19, Docker, PostgresSQL, and TypeORM.

This software is built with Robustness, System High-Availability and Reliability in mind.

How to Run and Use this project

Full Documentation is available in this readme file.

Contribution Guide

We appreciate any issues, pull requests, discussions and any help to make this repository a better resource.

Any Contribution, any suggestion, any bug fixes or improvements are welcome. Just follow these guidelines:

  1. Open a new issue on GitHub.
  2. Fork the repository.
  3. Create a new feature branch.
  4. Follow conventional commits specification. Keep commits atomic and well-described.
  5. Rebase on main before submitting PR
  6. Submit a PR.

Thank you for your interest and contribution.