2022-11-07 21:44:47 +00:00
|
|
|
# Contributing
|
2022-09-02 18:46:24 +00:00
|
|
|
|
2022-11-07 21:44:47 +00:00
|
|
|
> "First, thanks for considering to contribute to my project.
|
|
|
|
|
It really means a lot! 😁" - [@andrasbacsai](https://github.com/andrasbacsai)
|
2022-09-02 18:46:24 +00:00
|
|
|
|
2022-11-07 21:44:47 +00:00
|
|
|
You can ask for guidance anytime on our
|
|
|
|
|
[Discord server](https://coollabs.io/discord) in the `#contribution` channel.
|
2022-09-02 18:46:24 +00:00
|
|
|
|
2022-11-07 21:58:54 +00:00
|
|
|
You'll need a set of skills to [get started](docs/contribution/GettingStarted.md).
|
2022-11-07 21:58:06 +00:00
|
|
|
|
2022-11-07 21:44:47 +00:00
|
|
|
## 1) Setup your development environment
|
2022-10-05 09:13:51 +00:00
|
|
|
|
2023-02-10 09:09:16 +00:00
|
|
|
- 🌟 [Container based](docs/dev_setup/Container.md) ← *Recommended*
|
2022-11-07 21:44:47 +00:00
|
|
|
- 📦 [DockerContainer](docs/dev_setup/DockerContiner.md) *WIP
|
|
|
|
|
- 🐙 [Github Codespaces](docs/dev_setup/GithubCodespaces.md)
|
|
|
|
|
- ☁️ [GitPod](docs/dev_setup/GitPod.md)
|
|
|
|
|
- 🍏 [Local Mac](docs/dev_setup/Mac.md)
|
2022-09-02 18:46:24 +00:00
|
|
|
|
2022-11-07 21:44:47 +00:00
|
|
|
## 2) Basic requirements
|
2022-09-02 18:46:24 +00:00
|
|
|
|
2022-11-07 21:44:47 +00:00
|
|
|
- [Install Pnpm](https://pnpm.io/installation)
|
2022-11-07 21:56:14 +00:00
|
|
|
- [Install Docker Engine](https://docs.docker.com/engine/install/)
|
|
|
|
|
- [Setup Docker Compose Plugin](https://docs.docker.com/compose/install/compose-plugin/)
|
|
|
|
|
- [Setup GIT LFS Support](https://git-lfs.github.com/)
|
2022-10-05 09:13:51 +00:00
|
|
|
|
2022-11-07 21:44:47 +00:00
|
|
|
## 3) Setup Coolify
|
2022-09-02 18:46:24 +00:00
|
|
|
|
2022-11-07 21:44:47 +00:00
|
|
|
- Copy `apps/api/.env.example` to `apps/api/.env`
|
|
|
|
|
- Edit `apps/api/.env`, set the `COOLIFY_APP_ID` environment variable to something cool.
|
|
|
|
|
- Run `pnpm install` to install dependencies.
|
2023-02-10 09:09:16 +00:00
|
|
|
- Run `pnpm db:push` to create a local SQlite database. This will apply all migrations at `db/dev.db`.
|
2022-11-07 21:44:47 +00:00
|
|
|
- Run `pnpm db:seed` seed the database.
|
|
|
|
|
- Run `pnpm dev` start coding.
|
2022-09-02 18:46:24 +00:00
|
|
|
|
2022-11-07 21:44:47 +00:00
|
|
|
```sh
|
2023-02-10 09:09:16 +00:00
|
|
|
# Or... Copy and paste commands below:
|
2022-11-23 20:00:01 +00:00
|
|
|
cp apps/api/.env.example apps/api/.env
|
2022-11-07 21:44:47 +00:00
|
|
|
pnpm install
|
|
|
|
|
pnpm db:push
|
|
|
|
|
pnpm db:seed
|
|
|
|
|
pnpm dev
|
|
|
|
|
```
|
2022-09-02 18:46:24 +00:00
|
|
|
|
2022-11-07 21:44:47 +00:00
|
|
|
## 4) Start Coding
|
2022-09-02 18:46:24 +00:00
|
|
|
|
2022-11-07 21:44:47 +00:00
|
|
|
You should be able to access `http://localhost:3000`.
|
2022-09-02 18:46:24 +00:00
|
|
|
|
2023-02-10 09:09:16 +00:00
|
|
|
1. Click `Register` and setup your first user.
|
