Merge branch 'main' into main

This commit is contained in:
Andras Bacsai 2022-05-31 11:23:34 +02:00 committed by GitHub
commit 3f8d44a01c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 18 deletions

View File

@ -7,21 +7,18 @@
// Update 'VARIANT' to pick a Node version: 18, 16, 14. // Update 'VARIANT' to pick a Node version: 18, 16, 14.
// Append -bullseye or -buster to pin to an OS version. // Append -bullseye or -buster to pin to an OS version.
// Use -bullseye variants on local arm64/Apple Silicon. // Use -bullseye variants on local arm64/Apple Silicon.
"args": { "VARIANT": "16-bullseye" } "args": {
"VARIANT": "16-bullseye"
}
}, },
// Set *default* container specific settings.json values on container create. // Set *default* container specific settings.json values on container create.
"settings": {}, "settings": {},
// Add the IDs of extensions you want installed when the container is created. // Add the IDs of extensions you want installed when the container is created.
"extensions": ["dbaeumer.vscode-eslint"], "extensions": ["dbaeumer.vscode-eslint", "svelte.svelte-vscode"],
// Use 'forwardPorts' to make a list of ports inside the container available locally. // Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [], "forwardPorts": [3000],
// Use 'postCreateCommand' to run commands after the container is created. // Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "yarn install", "postCreateCommand": "cp .env.template .env && pnpm install && pnpm db:push && pnpm db:seed",
// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
"remoteUser": "node", "remoteUser": "node",
"features": { "features": {

View File

@ -15,6 +15,12 @@ ## 🙋 Want to help?
## 👋 Introduction ## 👋 Introduction
### Setup with github codespaces
If you have github codespaces enabled then you can just create a codespace and run `pnpm dev` to run your the dev environment. All the required dependencies and packages has been configured for you already.
### Setup locally in your machine
> 🔴 At the moment, Coolify **doesn't support Windows**. You must use Linux or MacOS. 💡 Although windows users can use github codespaces for development > 🔴 At the moment, Coolify **doesn't support Windows**. You must use Linux or MacOS. 💡 Although windows users can use github codespaces for development
#### Recommended Pull Request Guideline #### Recommended Pull Request Guideline
@ -35,18 +41,16 @@ # How to start after you set up your local fork?
You need to have [Docker Engine](https://docs.docker.com/engine/install/) installed locally. You need to have [Docker Engine](https://docs.docker.com/engine/install/) installed locally.
#### Setup a local development environment #### Steps for local setup
- Copy `.env.template` to `.env` and set the `COOLIFY_APP_ID` environment variable to something cool. 1. Copy `.env.template` to `.env` and set the `COOLIFY_APP_ID` environment variable to something cool.
- Install dependencies with `pnpm install`. 2. Install dependencies with `pnpm install`.
- Need to create a local SQlite database with `pnpm db:push`. 3. Need to create a local SQlite database with `pnpm db:push`.
- This will apply all migrations at `db/dev.db`.
- Seed the database with base entities with `pnpm db:seed`
- You can start coding after starting `pnpm dev`.
#### How to start after you set up your local fork? This will apply all migrations at `db/dev.db`.
This repository works better with [pnpm](https://pnpm.io) due to the lock file. 4. Seed the database with base entities with `pnpm db:seed`
5. You can start coding after starting `pnpm dev`.
## 🧑‍💻 Developer contribution ## 🧑‍💻 Developer contribution