mirror of https://github.com/lissy93/dashy
Calls config validator when serve starts, and adds documentation in readme
This commit is contained in:
parent
d27fbaac55
commit
7d5a99d9d3
11
README.md
11
README.md
|
@ -42,6 +42,8 @@
|
||||||
|
|
||||||
### Deploying from Docker Hub 🐳
|
### Deploying from Docker Hub 🐳
|
||||||
|
|
||||||
|
You will need [Docker](https://docs.docker.com/get-docker/) installed on your system
|
||||||
|
|
||||||
```docker
|
```docker
|
||||||
docker run -d \
|
docker run -d \
|
||||||
-p 8080:80 \
|
-p 8080:80 \
|
||||||
|
@ -50,16 +52,19 @@ docker run -d \
|
||||||
--restart=always \
|
--restart=always \
|
||||||
lissy93/dashy:latest
|
lissy93/dashy:latest
|
||||||
```
|
```
|
||||||
After making changes to your configuration file, you will need to run: `docker exec -it [container-id] yarn build` to rebuild. Container ID can be found by running `docker ps`
|
After making changes to your configuration file, you will need to run: `docker exec -it [container-id] yarn build` to rebuild. You can also run other commands, such as `yarn validate-config` this way too. Container ID can be found by running `docker ps`.
|
||||||
|
|
||||||
### Deploying from Source 🚀
|
### Deploying from Source 🚀
|
||||||
|
|
||||||
|
You will need both [git](https://git-scm.com/downloads) and the latest or LTS version of [Node.js](https://nodejs.org/) installed on your system
|
||||||
|
|
||||||
- Get Code: `git clone git@github.com:Lissy93/dashy.git` and `cd dashy`
|
- Get Code: `git clone git@github.com:Lissy93/dashy.git` and `cd dashy`
|
||||||
- Configuration: Fill in you're settings in `./public/conf.yml`
|
- Configuration: Fill in you're settings in `./public/conf.yml`
|
||||||
- Install dependencies: `yarn`
|
- Install dependencies: `yarn`
|
||||||
- Build: `yarn build`
|
- Build: `yarn build`
|
||||||
- Run: `yarn start`
|
- Run: `yarn start`
|
||||||
|
|
||||||
After making changes to your configuration file, you will need to run: `yarn build` to rebuild
|
After making changes to your configuration file, you will need to run: `yarn build` to rebuild.
|
||||||
|
You can check that your config is valid, and matches the schema by running `yarn validate-config`
|
||||||
|
|
||||||
### Developing 🧱
|
### Developing 🧱
|
||||||
- Get Code: `git clone git@github.com:Lissy93/dashy.git` and `cd dashy`
|
- Get Code: `git clone git@github.com:Lissy93/dashy.git` and `cd dashy`
|
||||||
|
|
|
@ -8,9 +8,11 @@
|
||||||
"build": "vue-cli-service build",
|
"build": "vue-cli-service build",
|
||||||
"lint": "vue-cli-service lint --fix",
|
"lint": "vue-cli-service lint --fix",
|
||||||
"build-watch": "vue-cli-service build --watch",
|
"build-watch": "vue-cli-service build --watch",
|
||||||
"build-and-start": "npm-run-all --parallel build start"
|
"build-and-start": "npm-run-all --parallel build start",
|
||||||
|
"validate-config": "node src/utils/ConfigValidator"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
"ajv": "^8.5.0",
|
||||||
"axios": "^0.21.1",
|
"axios": "^0.21.1",
|
||||||
"connect": "^3.7.0",
|
"connect": "^3.7.0",
|
||||||
"crypto-js": "^4.0.0",
|
"crypto-js": "^4.0.0",
|
||||||
|
|
|
@ -5,6 +5,8 @@ const util = require('util');
|
||||||
const dns = require('dns');
|
const dns = require('dns');
|
||||||
const os = require('os');
|
const os = require('os');
|
||||||
|
|
||||||
|
require('./src/utils/ConfigValidator');
|
||||||
|
|
||||||
const port = process.env.PORT || 80;
|
const port = process.env.PORT || 80;
|
||||||
|
|
||||||
/* eslint no-console: 0 */
|
/* eslint no-console: 0 */
|
||||||
|
|
Loading…
Reference in New Issue