IMT-3A-PROCOM-ERP is a project to develop a modular Enterprise Resource Planning system. The solution enables a ready-to-use product to be produced quickly, for new small businesses of all types (shops, restaurants, etc). Depending on their needs, companies can have a package with only the necessary functionalities, while being able to add or remove functionality later almost instantaneously.
Here the poster we presented :
Here is a sneak peak of the Application, here the Directory service's full Users list :
For the moment, the modules on offer are:
- Authentication service
- Directory service
- Order service
Other services, such as an inventory service, are in the pipeline.
NB: This project is part of the ProCom teaching unit in the 3rd year of the engineering course at IMT Atlantique. It is not really intended to be marketed, but rather to serve as a pedagogical model made to showcase to students the challenges of distribued systems and developing one.
You can find a comprehensive Deployment guide on how to deploy our system, in the documentation section. After having deployed, you can find a comprehensive Usage guide on how to use our system.
- Timestamp: 2023-11-02
- Last update: 2024-03-31
- Status: In development
- Current Version: 1.1.0
- Supported Platforms: Windows, Linux and MacOS
- Development Environment:
- Programming languages:
- HTML5 / CCS3 / JavaScript
- Java 17
- SQL (PostgreSQL 13)
- Libraries / Frameworks / Platforms:
- Compatibility Issues : None known at this time
IMT-3A-PROCOM-ERP/ This repository
├── README.md This document
├── CODE_OF_CONDUCT.md Code of conduct you have to follow on this project
├── SECURITY.md Security information, such as known vulnerabilities, or how to report them
├── LICENSE.md License in place for this project
├── deploy.sh Complete deploy script (available in a .ps1 for Windows devs)
├── undeploy.sh Undeploy script (available in a .ps1 for Windows devs)
├── pom.xml Maven parent configuration file for all backend services (modules) for development purposes (IDE LSP detection)
├── .github/ Used by GitHub for CI/CD processes
│ ├── CODEOWNERS Detail which team-member has to review which changes
│ └── workflows/ All CI/CD auto-running tasks depending on the triggered event
│ └── ...
├── src/ All the source code of the project
│ ├── frontend/ Code for the UI
│ │ ├── service-1/ Subproject with frontend code
│ │ │ ├── Dockerfile Dockerfile describing the operations required to build each service's image
│ │ │ ├── Public/ Frontend public source code
│ │ │ ├── src/ Frontend source code
│ │ │ └── ...
│ ├── backend/ Code for microservices
│ │ ├── service-1/ One service
│ │ │ ├── pom.xml Maven child configuration file for the service in development (IDE LSP detection)
│ │ │ ├── prod-pom.xml Maven child configuration file for the service in production
│ │ │ ├── Dockerfile Dockerfile describing the operations required to build each service's image
│ │ │ ├── src/ Backend source code
│ │ │ └── ...
│ │ └── service-n/ Another service
│ │ └── ...
│ └── databases/ Databases scripts and configurations
│ ├── db-1/ One database
│ │ ├── Dockerfile Dockerfile describing the operations required to build each service's image
│ │ ├── reset.sql Script to reset all tables in a relationnal database
│ │ └── init.sql Script to create tables in a relationnal database
│ └── db-n/ Another database
│ └── ...
│
├── system/ System files: all entrypoints specific scripts, and centralized certificates
│ ├── db_entrypoint.sh Entrypoint for the databases
│ ├── entrypoint.sh Entrypoint for the backend services
│ ├── mvnw Maven Wrapper copied to every service to better control maven version
│ └── wait-for-it.sh Handy script that waits for the availability of an service to execute a given command
│
├── security/ Security scripts (./deploy.sh uses all except for clean_security.sh), all are available in a .ps1 for Windows devs
│ ├── clean_security.sh Cleans all certificates from the repository
│ ├── docker_secrets.sh Generates all the docker secrets necessary for the deployment with normal compose
│ ├── docker_secrets_files.sh Generates all docker secrets in swarm mode
│ ├── security_setup.sh Generates all needed certificates in the repository
│ └── ... Other scripts, such as the docker secrets scripts, or certicate generations
│
├── docker/ Directory for Docker related files
│ ├── elk / Directory for all the Elastic Stack, imported and adapted to our project from deviantony/docker-elk.
│ │ └── ...
│ ├── .env Environment variables of the projet
│ ├── docker-compose.yml Docker containers build script to simulate the project
│ └── docker-compose-swarm.yml Docker containers build script to simulate the project Swarm mode
│
└── docs/ All technical and GitHub workflows documentation
├── diagrams/ UML and other diagrams
├── contributing/
│ ├── workflow-git-action.png Sequence diagram for a specific action to realise
│ └── CONTRIBUTING.md Explains how to contribute to the project, by respecting some rules
├── security/ Security specific files
│ └── templates/ Security templates
├── api/ All APIs for all services are documented here
│ └── doc-api-xxx-service.json An API documentation
├── CHANGELOG.md Tracked changes in the project's lifecycle
├── FEATURES.md Brief list of features
├── MODELING.md Conception documentation on the ERP's architecture
├── ROADMAP.md Next steps ahead, for future contributors
├── DEPLOYING.md A comprehensive guide on how to deploy our system
└── USAGE.md A comprehensive guide on how to use our system once deployed (tailored to educational purposes)
The PROCOM-ERP GitHub organisation owns this repository,
meaning that you have to be a member to contribute.
In the organisation, several teams are created in order to affect responsibility, like code review, to members.
They are used in this project in the CODEOWNERS file,
to auto-create review requirement when changes impact specific parts of the repository.
For instance: if backend-owner team owns src/backend/,
any changes in this directory will need a review acceptation from a member of the team before being merged.
CONTRIBUTING.md file explains how to contribute to the project, and what are the contributing rules.
We follow a CODE_OF_CONDUCT.md, if you want to contribute, you will have to follow it.
You can verify the versions of this software still maintained to this day, as well as how to report a bug or security issue in the SECURITY.md section.
For specific internal security documentation, see our security guide at SYSTEM_SECURITY.md.
Any enhancement idea can be suggested in an Feature Request Issue, following the Feature Request template.
We are under the MIT License, find out more in the License section.
Many thanks to the different contributors for their contribution to the project. Find their names and missions in Contributors section.
Thanks also to external resources for their open-source samples / documentation:
- Baeldung: Java Spring Boot tutorials and code samples
- Vertabelo: Data modeling
- vishnubob: wait-for-it.sh script
- deviantony: the entirety of Elastic Stack preconfigured, very helpufl, we only had to adjust it a little as indicated in the Docker ELK README.
- BOPS (from 2023-10-01 until 2024-03-31): Project Manager, Backend Engineer & Developer, Security Support, System Support
- maestro-bene (from 2023-10-01): Backend Engineer & Developer, System Administrator, Head of Security
- Antoine (from 2023-10-01 until 2024-03-31): Product Owner Support, Frontend & UI/UX Support
- ArthurMaquinImt (from 2023-10-01 until 2024-03-31): Backend Engineer & Developer
- yunea (from 2023-10-01 until 2024-03-31): Frontend & UI/UX Developer