SWM

Development Environment

Warning

This project was built solely on Linux. Nobody in the team uses Windows, and we couldn't do much to ensure compatibility with non-Unix systems. Please be aware that you might face some issues while trying to get it up and running on other systems.

Setup

This project was built with:

• NodeJS v22,
• Yarn v4.9.1,
• Docker v27.5.1

Older versions of these tools might not work.

To download the dependencies, run:

$ yarn install

Usage

After finishing the setup, you'll be able to use numerous commands, for example:

• $ docker compose up --detach && yarn dev to start the app,
• $ yarn build to build it,
• $ yarn lint to lint the whole project

Running the first command will cause the following ports to become responsive:

• localhost:3000 - App,
• localhost:5432 - Database (PostgreSQL),
• localhost:3001 - Database UI (Adminer),
• localhost:25 - Mail Server (MailHog),
• localhost:3002 - Mail Server UI (MailHog),
• localhost:9000 - Storage Service (MinIO),
• localhost:3003 - Storage Service UI (MinIO Console),
• localhost:3004 - Documentation (Docusaurus),

For more insights please visit the documentation, either running locally after finishing above setup, or a publicly hosted instance.