README.md

Supreme Erp

Fun project built and designed by Team 9 for Soen390

Table of Contents

1. About The Project
   • Demo
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Running Using Docker
3. More Information
4. Contributors

About The Project

Supreme ERP is an ERP (enterprise resource planning) web app which is targeted towards a company that is looking to handle the production and sales of bikes

Demo

• Try the live demo for free here: https://erp-supreme.web.app/
• Default credentials: admin@email.com for the email and admin for the password

Built With

• Frontend Framework React
• Backend Framework Express
• RDMS MySql
• Language TypeScript
• CI/CD service GitHub Actions

Getting Started

Prerequisites

• Install Docker

Installation

1. Request access to the environment repository
2. Clone the repo with the submodules included

   git clone https://github.com/Talos10/SOEN390-team-9.git --recursive
   

Running Using Docker

• Start Supreme ERP

  docker-compose up
  

• OR start a single service

  docker-compose up (backend or frontend or database)
  

• Default credentials: admin@email.com for the email and admin for the password
• Frontend is hosted on http://localhost:3000
• Backend is hosted on http://localhost:5000
• Database is hosted on http://localhost:3306
• To test the app, go to the frontend

More Info

• Docker
• Backend
• Frontend

Contributors

Name	Github
Razvan Ivan	Talos10
Jason Kim	Gahyki
David Rossi	d-rossi
Cosmin Sustac	N0ot-No0t
Tommy Josépovic	tommy-josepovic
Patrick Youssef	PatrickYoussef
Phong Le	phong1233
Sébastien Blain-Nadeau	sebastien-blain