From 11f108b501d8c1bb9583b186bcb9194a10cdddbb Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Mon, 2 Sep 2024 10:26:17 +0800 Subject: [PATCH] Remove .devcontainer (#5074) --- .devcontainer/README.md | 28 ---------------------------- .devcontainer/devcontainer.json | 23 ----------------------- .dockerignore | 1 - CONTRIBUTING.md | 6 ------ 4 files changed, 58 deletions(-) delete mode 100644 .devcontainer/README.md delete mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/README.md b/.devcontainer/README.md deleted file mode 100644 index 81b8b0fa..00000000 --- a/.devcontainer/README.md +++ /dev/null @@ -1,28 +0,0 @@ -# Codespaces - -You can modifiy Uptime Kuma in your browser without setting up a local development. - -![image](https://github.com/louislam/uptime-kuma/assets/1336778/31d9f06d-dd0b-4405-8e0d-a96586ee4595) - -1. Click `Code` -> `Create codespace on master` -2. Wait a few minutes until you see there are two exposed ports -3. Go to the `3000` url, see if it is working - -![image](https://github.com/louislam/uptime-kuma/assets/1336778/909b2eb4-4c5e-44e4-ac26-6d20ed856e7f) - -## Frontend - -Since the frontend is using [Vite.js](https://vitejs.dev/), all changes in this area will be hot-reloaded. -You don't need to restart the frontend, unless you try to add a new frontend dependency. - -## Backend - -The backend does not automatically hot-reload. -You will need to restart the backend after changing something using these steps: - -1. Click `Terminal` -2. Click `Codespaces: server-dev` in the right panel -3. Press `Ctrl + C` to stop the server -4. Press `Up` to run `npm run start-server-dev` - -![image](https://github.com/louislam/uptime-kuma/assets/1336778/e0c0a350-fe46-4588-9f37-e053c85834d1) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json deleted file mode 100644 index 6e3282dc..00000000 --- a/.devcontainer/devcontainer.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "image": "mcr.microsoft.com/devcontainers/javascript-node:dev-18-bookworm", - "features": { - "ghcr.io/devcontainers/features/github-cli:1": {} - }, - "updateContentCommand": "npm ci", - "postCreateCommand": "", - "postAttachCommand": { - "frontend-dev": "npm run start-frontend-devcontainer", - "server-dev": "npm run start-server-dev", - "open-port": "gh codespace ports visibility 3001:public -c $CODESPACE_NAME" - }, - "customizations": { - "vscode": { - "extensions": [ - "streetsidesoftware.code-spell-checker", - "dbaeumer.vscode-eslint", - "GitHub.copilot-chat" - ] - } - }, - "forwardPorts": [3000, 3001] -} diff --git a/.dockerignore b/.dockerignore index 4ef25f5e..5db08b7b 100644 --- a/.dockerignore +++ b/.dockerignore @@ -17,7 +17,6 @@ README.md .vscode .eslint* .stylelint* -/.devcontainer /.github yarn.lock app.json diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b37b5d8..69f98c0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -236,12 +236,6 @@ The goal is to make the Uptime Kuma installation as easy as installing a mobile - IDE that supports [`ESLint`](https://eslint.org/) and EditorConfig (I am using [`IntelliJ IDEA`](https://www.jetbrains.com/idea/)) - A SQLite GUI tool (f.ex. [`SQLite Expert Personal`](https://www.sqliteexpert.com/download.html) or [`DBeaver Community`](https://dbeaver.io/download/)) -### GitHub Codespaces - -If you don't want to setup an local environment, you can now develop on GitHub Codespaces, read more: - -https://github.com/louislam/uptime-kuma/tree/master/.devcontainer - ## Git Branches - `master`: 2.X.X development. If you want to add a new feature, your pull request should base on this.