mirror of
https://github.com/jcreek/EstimationPoker.git
synced 2026-07-12 18:43:47 +00:00
docs(*): Update readme
This commit is contained in:
@@ -1,2 +1,63 @@
|
||||
# EstimationPoker
|
||||
A web app to allow scrum teams to easily perform estimations quickly and without unnecessary effort.
|
||||
|
||||
There are two components to this:
|
||||
|
||||
1. Frontend, built using SvelteKit
|
||||
2. WebSockets server, built using Node.js
|
||||
|
||||
## To Do
|
||||
|
||||
- add estimate
|
||||
- change estimate
|
||||
- reveal estimates (aka stop estimation)
|
||||
- restart estimation
|
||||
|
||||
## Potential Enhancements
|
||||
|
||||
- throw emoji at people
|
||||
- add a shield to anyone named 'Tristan' whenever the poop emoji is thrown at them
|
||||
|
||||
## Frontend
|
||||
|
||||
For full functionality, ensure there is a copy of the WebSockets server running.
|
||||
|
||||
### Developing
|
||||
|
||||
Once you've installed dependencies with `npm install`, start a development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
|
||||
# or start the server and open the app in a new browser tab
|
||||
npm run dev -- --open
|
||||
```
|
||||
|
||||
### Building
|
||||
|
||||
To create a production version:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
You can preview the production build with `npm run preview`.
|
||||
|
||||
### Favicon
|
||||
|
||||
This favicon was [generated](https://favicon.io/favicon-generator/) using the following font:
|
||||
|
||||
- Font Title: Fuzzy Bubbles
|
||||
- Font Author: Copyright 2005 The Fuzzy Bubbles Project Authors (https://github.com/googlefonts/fuzzy-bubbles)
|
||||
- Font Source: http://fonts.gstatic.com/s/fuzzybubbles/v5/6qLbKZMbrgv9pwtjPEVNV0F2Ds_WQxMAZkM1pn4.ttf
|
||||
- Font License: SIL Open Font License, 1.1 (http://scripts.sil.org/OFL))
|
||||
|
||||
## WebSockets Server
|
||||
|
||||
### Developing
|
||||
|
||||
Once you've installed dependencies with `npm install`, start a development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user