Merge pull request #169 from purplship/purplship-dashboard-2021.11

[release-candidate] Purplship dashboard 2021.11

README.md

@@ -37,9 +37,16 @@ npm install
 
 Use the following environment variables to configure the dashboard:
 
-- `NEXT_PUBLIC_PURPLSHIP_API_URL` (**required**) - URL of a running instance of purplship-server. If you are running purplship-server locally with the default settings, set `NEXT_PUBLIC_PURPLSHIP_API_URL` to: `http://localhost:5002`.
+- `NEXT_PUBLIC_PURPLSHIP_API_URL` (**required**) - URL of a running instance of purplship server. If you are running purplship-server locally with the default settings, set `NEXT_PUBLIC_PURPLSHIP_API_URL` to: `http://localhost:5002`.
+
+- `JWT_SECRET` (**required**) - A secret to use for JWT key generation - you should set this explicitly.
+
+- `NEXTAUTH_URL` (**required**) - The URL of your dashboard to restrict the authentication host to your instance. If you are running the dashboard locally, set `NEXTAUTH_URL` to: `http://localhost:3000`.
+
+- `PURPLSHIP_HOSTNAME` - URL of a running instance of purplship server. Useful for an ingress network request from the node side of the dashboard.
+
+- `BASE_PATH` - A base path to use for deploying the dashboard to a domain subpath. e.g. `instance.purplship.com/dashboard`
 
-- `JWT_SECRET` - A secret to use for JWT key generation - you should set this explicitly.
 
 #### Development
 

docker/Dockerfile

@@ -39,4 +39,4 @@ USER pship
 
 EXPOSE 3000
 
-CMD ["npm", "run", "start"]
+CMD ["node_modules/.bin/next", "start"]

next.config.js

@@ -1,14 +1,17 @@
 const path = require('path')
 
 module.exports = {
+ basePath: process.env.BASE_PATH || '',
  reactStrictMode: true,
  sassOptions: {
  includePaths: [path.join(__dirname, 'src', 'styles')],
  },
  serverRuntimeConfig: {
  JWT_SECRET: process.env.JWT_SECRET,
+ PURPLSHIP_HOSTNAME: process.env.PURPLSHIP_HOSTNAME || process.env.NEXT_PUBLIC_PURPLSHIP_API_URL,
  },
  publicRuntimeConfig: {
+ BASE_PATH: process.env.BASE_PATH || '',
  PURPLSHIP_API_URL: process.env.NEXT_PUBLIC_PURPLSHIP_API_URL
  }
 }

package.json

@@ -36,4 +36,4 @@
  "eslint-config-next": "11.0.1",
  "typescript": "4.3.5"
  }
-}
+}

public/manifest.json

@@ -3,19 +3,19 @@
  "name": "Purple Board",
  "icons": [
  {
- "src": "\/android-chrome-192x192.png",
+ "src": "android-chrome-192x192.png",
  "sizes": "192x192",
  "type": "image\/png",
  "density": "4.0"
  },
  {
- "src": "\/android-chrome-512x512.png",
+ "src": "android-chrome-512x512.png",
  "sizes": "512x512",
  "type": "image\/png",
  "density": "4.0"
  }
  ],
- "start_url": "\/",
+ "start_url": "",
  "display": "standalone",
  "theme_color": "#9504af",
  "background_color": "#9504af"

scripts/generate-pship-client.sh

@@ -1,9 +1,15 @@
 #!/usr/bin/env bash
+branch="${1:=main}"
 
 docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \
- -i /local/scripts/openapi.json \
+ -i "https://raw.githubusercontent.com/purplship/purplship/${branch}/server/schemas/openapi.json" \
  -g typescript-fetch \
- -o /local/src/api/generated \
+ -o /local/src/purplship/rest/generated \
  --additional-properties=typescriptThreePlus=true \
  --additional-properties=modelPropertyNaming=snake_case \
  --additional-properties=useSingleRequestParameter=True
+
+rm -rf src/purplship/rest/generated/index.ts \
+ src/purplship/rest/generated/apis/index.ts \
+ src/purplship/rest/generated/.openapi-generator-ignore \
+ src/purplship/rest/generated/.openapi-generator/

scripts/generate-pship-graphql-types.sh

@@ -1,6 +1,11 @@
 #!/usr/bin/env bash
+branch="${1:=main}"
 
-apollo-codegen generate "src/graphql/queries.ts" \
- --schema "scripts/graphql.json" \
+curl https://raw.githubusercontent.com/purplship/purplship/${branch}/server/schemas/graphql.json --output graphql.json
+
+apollo-codegen generate "src/purplship/graphql/queries.ts" \
+ --schema "./graphql.json" \
  --target typescript \
- --output "src/graphql/types.ts"
+ --output "src/purplship/graphql/types.ts"
+
+rm -f graphql.json