mirror of
https://github.com/Lissy93/dashy.git
synced 2024-11-23 12:43:52 +03:00
Adds PWD deploy link, credits external services, links to discussions tab
This commit is contained in:
Alicia Sykes
parent
50bbce450f
commit
c2ec36baab
12
README.md
12
README.md
@ -29,9 +29,7 @@
|
||||
|
||||
**Live Demos**: [Demo 1](https://dashy-demo-1.as93.net) ┆ [Demo 2](https://dashy-demo-2.as93.net) ┆ [Demo 3](https://dashy-demo-3.as93.net)
|
||||
|
||||
**Spin up your own demo**:
|
||||
|
||||
You can try Dashy out for yourself, with a single click- thanks to the amazing folks at [Play-with-Docker](https://play-with-docker.com/). [](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
**Spin up your own demo**: [](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
|
||||
**Screenshots**
|
||||
|
||||
@ -150,16 +148,18 @@ Before you submit your pull request, please ensure the following:
|
||||
|
||||
## Support 🙋♀️
|
||||
|
||||
If you've found a bug, or something that isn't working as you'd expect, please raise an issue, so that it can be resolved. Similarly, if you're having trouble getting things up and running, feel free to ask a question. Feature requests and feedback are also welcome, as it helps Dashy improve.
|
||||
> For general discussions, the [Discussions Board](https://github.com/Lissy93/dashy/discussions) is now active!
|
||||
|
||||
If you've found a bug, or something that isn't working as you'd expect, please raise an issue, so that it can be resolved. Similarly, if you're having trouble getting things up and running, feel free to ask a question. Feature requests and feedback are also welcome, as it helps Dashy improve.
|
||||
|
||||
- [Raise a Bug 🐛](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%90%9B+Bug&template=bug-report---.md&title=%5BBUG%5D)
|
||||
- [Submit a Feature Request 🦄](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%A6%84+Feature+Request&template=feature-request---.md&title=%5BFEATURE_REQUEST%5D)
|
||||
- [Ask a Question 🤷♀️](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%A4%B7%E2%80%8D%E2%99%82%EF%B8%8F+Question&template=question------.md&title=%5BQUESTION%5D)
|
||||
- [Share Feedback 🌈](https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%8C%88+Feedback&template=share-feedback---.md&title=%5BFEEDBACK%5D)
|
||||
|
||||
For general questions about any of the technologies used, you should search the [web](https://duckduckgo.com), or open a question on [StackOverflow](https://stackoverflow.com/questions/)
|
||||
For more general questions about any of the technologies used, [StackOverflow](https://stackoverflow.com/questions/) may be more helpful first port of info
|
||||
|
||||
If you need to get in touch securely with the author me, you can send any messages to me at:
|
||||
If you need to get in touch securely with the author (me, Alicia Sykes), drop me a message at:
|
||||
- **Email**: `alicia at omg dot lol`
|
||||
- **Public Key** [`0688 F8D3 4587 D954 E9E5 1FB8 FEDB 68F5 5C02 83A7`](https://keybase.io/aliciasykes/pgp_keys.asc?fingerprint=0688f8d34587d954e9e51fb8fedb68f55c0283a7)
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
# Getting Started
|
||||
|
||||
- [Deployment](#deployment)
|
||||
- [1-Click Deploy](#1-click-deploy)
|
||||
- [Deploy with Docker](#deploy-with-docker)
|
||||
- [Deploy from Source](#deploy-from-source)
|
||||
- [Usage](#usage)
|
||||
@ -12,12 +13,18 @@
|
||||
- [Updating from Source](#updating-from-source)
|
||||
|
||||
## Deployment
|
||||
|
||||
### 1-Click Deploy
|
||||
|
||||
If you just want to test Dashy out, then you have several options:
|
||||
- You can spin up a container with PWD by [clicking here](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
- Or on your own system, by running: `docker run -p 8080:80 lissy93/dashy`, then open your browser and visit `http://localhost:8080`
|
||||
- Or you can check out the live demo, [here](http://dashy-demo-1.as93.net/)
|
||||
|
||||
### Deploy with Docker
|
||||
|
||||
The quickest way to get started on any system is with Docker, and Dashy is available though [Docker Hub](https://hub.docker.com/r/lissy93/dashy). You will need [Docker](https://docs.docker.com/get-docker/) installed on your system.
|
||||
|
||||
To test it out, just run: `docker run -p 8080:80 lissy93/dashy`, then open your browser and visit `http://localhost:8080`. Or to try it out in the cloud, you can deploy to PWD by [clicking here](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml).
|
||||
|
||||
To configure Dashy with your own services, and customize it to your liking, you will need to write a config file, and pass it to the Docker container as a volume.
|
||||
|
||||
```docker
|
||||
@ -39,6 +46,12 @@ Explanation of the above options:
|
||||
|
||||
For all available options, and to learn more, see the [Docker Run Docs](https://docs.docker.com/engine/reference/commandline/run/)
|
||||
|
||||
You can also build and deploy the Docker container from source.
|
||||
- Get the code: `git clone git@github.com:Lissy93/dashy.git && cd dashy`
|
||||
- Edit the `./public/conf.yml` file and take a look at the `docker-compose.yml`
|
||||
- Start the container: `docker compose up`
|
||||
|
||||
|
||||
### Deploy from Source
|
||||
If you do not want to use Docker, you can run Dashy directly on your host system. For this, you will need both [git](https://git-scm.com/downloads) and the latest or LTS version of [Node.js](https://nodejs.org/) installed.
|
||||
|
||||
@ -48,6 +61,8 @@ If you do not want to use Docker, you can run Dashy directly on your host system
|
||||
4. Build: `yarn build`
|
||||
5. Run: `yarn start`
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
### Providing Assets
|
||||
Although not essential, you will most likely want to provide several assets to Dashy. All web assets can be found in the `/public` directory.
|
||||
@ -72,6 +87,7 @@ The following commands are defined in the [`package.json`](https://github.com/Li
|
||||
- **`yarn build-watch`** - If you find yourself making frequent changes to your configuration, and do not want to have to keep manually rebuilding, then this option is for you. It will watch for changes to any files within the projects root, and then trigger a rebuild. Note that if you are developing new features, then `yarn dev` would be more appropriate, as it's significantly faster at recompiling (under 1 second), and has hot reloading, linting and testing integrated
|
||||
- **`yarn build-and-start`** - Builds the app, runs checks and starts the production server. Commands are run in parallel, and so is faster than running them in independently
|
||||
|
||||
---
|
||||
## Updating
|
||||
|
||||
Dashy is under active development, so to take advantage of the latest features, you may need to update your instance every now and again.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user