From a4f7c0d2d5ebc51684fcc3c7a16d9ccbfc4c8b5c Mon Sep 17 00:00:00 2001 From: Gareth Latty Date: Sat, 23 May 2020 22:04:50 +0100 Subject: [PATCH] Add issue templates, funding, and details for building. --- .github/FUNDING.yml | 1 + .github/ISSUE_TEMPLATE/bug-report.md | 26 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 11 ++++++++++ README.md | 8 ++++++- docker-compose.yml | 8 +++---- 5 files changed, 49 insertions(+), 5 deletions(-) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..65edaef --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: [Lattyware] diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..c59a016 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,26 @@ +--- +name: Bug Report +about: Create a report to help us fix a problem. +title: '' +labels: bug +assignees: '' +--- + +## Describe the bug +A clear and concise description of what the bug is. +Please copy and paste or screenshot any error you received. + + +## How to reproduce the bug +Steps to reproduce the behaviour: +1. Sign in +2. Go to the decks page +3. … + + +### Expected behaviour +A clear and concise description of what you expected to happen. + + +### Attachments +If you—for example—uploaded a deck, and it went wrong, please attach the .deck.json5 file here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..72748f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,11 @@ +--- +name: Feature Request +about: Ask us to add a new feature. +title: '' +labels: enhancement +assignees: '' +--- + +## Describe the feature +A clear and concise description of what the feature you would like is. + diff --git a/README.md b/README.md index 9706b6b..4a7d01b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # [Many Decks][hosted] -[![Build Status](https://img.shields.io/github/workflow/status/Lattyware/manydecks/Build%20and%20publish%20to%20GitHub.)](https://github.com/Lattyware/manydecks/actions) +[![Current Release Version](https://img.shields.io/github/v/tag/Lattyware/manydecks?label=release&sort=semver)](https://github.com/Lattyware/manydecks/releases) +[![Client Docker Build](https://img.shields.io/docker/cloud/build/massivedecks/manydecks-client?label=client%20docker%20build)][docker-client] +[![Server Docker Build](https://img.shields.io/docker/cloud/build/massivedecks/manydecks-server?label=server%20docker%20build)][docker-server] [![License](https://img.shields.io/github/license/Lattyware/manydecks)](LICENSE) Many Decks is a free, open source deck source that can be used to host decks for [Massive Decks][md], a comedy party game based on @@ -25,7 +27,11 @@ Many Decks is open source software available under [the AGPLv3 license](LICENSE) To use, [the hosted version][hosted] is easiest. +IF you wish to deploy your own version, the easiest way is to use the docker images, which can be found on Docker Hub: +[Client][docker-client]/[Server][docker-server]. +[docker-client]: https://hub.docker.com/r/massivedecks/manydecks-client +[docker-server]: https://hub.docker.com/r/massivedecks/manydecks-server ## Contributing diff --git a/docker-compose.yml b/docker-compose.yml index 4333b32..95ab329 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -21,8 +21,8 @@ services: server: container_name: server - image: "manydecks/server:dev" - build: "./server" + image: "massivedecks/manydecks-server:latest" + #build: "./server" depends_on: - storage environment: @@ -33,8 +33,8 @@ services: client: container_name: client - image: "manydecks/client:dev" - build: "./client" + image: "massivedecks/manydecks-client:latest" + #build: "./client" depends_on: - server ports: