Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
29 lines (20 loc) 路 928 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) 路 928 Bytes
Raw

Contributing

How to set up the project

Prerequisites

  • Install Bun
  • Install Golang
  • Install MySQL and create a database with name alexandrie (you can change it in config.toml)

Steps

  1. Clone the repository.
  2. Update the .env file in the /backend and /frontend directories with your credentials & configurations.
  3. Go to /backend and run go mod download to install the dependencies and then start with go run main.go.
  4. Start minio server with minio server ./minio --console-address :9001 --address "localhost:9000"
  5. Go to /frontend and run bun install, and then start with bun dev.

If you are on Linux you can use the following commands to start the application:

make frontend
make minio
make backend

How to contribute

Don't hesitate to contribute to the project. You can open an issue or a pull request :)