Merge pull request #433 from vasani-arpit/next
Support for Github codespaces and Service request issue template
This commit is contained in:
commit
3aef04437c
16
.devcontainer/Dockerfile
Normal file
16
.devcontainer/Dockerfile
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.233.0/containers/javascript-node/.devcontainer/base.Dockerfile
|
||||||
|
|
||||||
|
# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
|
||||||
|
ARG VARIANT="16-bullseye"
|
||||||
|
FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
|
||||||
|
|
||||||
|
# [Optional] Uncomment this section to install additional OS packages.
|
||||||
|
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
|
||||||
|
# && apt-get -y install --no-install-recommends <your-package-list-here>
|
||||||
|
|
||||||
|
# [Optional] Uncomment if you want to install an additional version of node using nvm
|
||||||
|
# ARG EXTRA_NODE_VERSION=10
|
||||||
|
# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
|
||||||
|
|
||||||
|
# [Optional] Uncomment if you want to install more global node modules
|
||||||
|
RUN su node -c "npm install -g pnpm"
|
28
.devcontainer/devcontainer.json
Normal file
28
.devcontainer/devcontainer.json
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
|
||||||
|
// https://github.com/microsoft/vscode-dev-containers/tree/v0.233.0/containers/javascript-node
|
||||||
|
{
|
||||||
|
"name": "Node.js",
|
||||||
|
"build": {
|
||||||
|
"dockerfile": "Dockerfile",
|
||||||
|
// Update 'VARIANT' to pick a Node version: 18, 16, 14.
|
||||||
|
// Append -bullseye or -buster to pin to an OS version.
|
||||||
|
// Use -bullseye variants on local arm64/Apple Silicon.
|
||||||
|
"args": {
|
||||||
|
"VARIANT": "16-bullseye"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
// Set *default* container specific settings.json values on container create.
|
||||||
|
"settings": {},
|
||||||
|
// Add the IDs of extensions you want installed when the container is created.
|
||||||
|
"extensions": ["dbaeumer.vscode-eslint", "svelte.svelte-vscode"],
|
||||||
|
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||||
|
"forwardPorts": [3000],
|
||||||
|
// Use 'postCreateCommand' to run commands after the container is created.
|
||||||
|
"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.
|
||||||
|
"remoteUser": "node",
|
||||||
|
"features": {
|
||||||
|
"docker-in-docker": "20.10",
|
||||||
|
"github-cli": "latest"
|
||||||
|
}
|
||||||
|
}
|
3
.github/ISSUE_TEMPLATE/config.yml
vendored
3
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -3,3 +3,6 @@ contact_links:
|
|||||||
- name: 🤔 Questions and Help
|
- name: 🤔 Questions and Help
|
||||||
url: https://discord.com/invite/6rDM4fkymF
|
url: https://discord.com/invite/6rDM4fkymF
|
||||||
about: Reach out to us on discord or our github discussions page.
|
about: Reach out to us on discord or our github discussions page.
|
||||||
|
- name: 🙋♂️ service request
|
||||||
|
url: https://feedback.coolify.io/
|
||||||
|
about: want to request a new service? for e.g wordpress, hasura, appwrite etc...
|
||||||
|
@ -15,7 +15,13 @@ ## 🙋 Want to help?
|
|||||||
|
|
||||||
## 👋 Introduction
|
## 👋 Introduction
|
||||||
|
|
||||||
🔴 At the moment, Coolify **doesn't support Windows**. You must use Linux or MacOS.
|
### 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
|
||||||
|
|
||||||
#### Recommended Pull Request Guideline
|
#### Recommended Pull Request Guideline
|
||||||
|
|
||||||
@ -35,20 +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. I recommend you to give it a try and use `pnpm` as well because it is cool and efficient!
|
4. Seed the database with base entities with `pnpm db:seed`
|
||||||
|
5. You can start coding after starting `pnpm dev`.
|
||||||
You need to have [Docker Engine](https://docs.docker.com/engine/install/) installed locally.
|
|
||||||
|
|
||||||
## 🧑💻 Developer contribution
|
## 🧑💻 Developer contribution
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user