Skip to content

Commit

Permalink
A much more helpful readme
Browse files Browse the repository at this point in the history
  • Loading branch information
noahm committed Mar 29, 2019
1 parent 0d32291 commit 0860ad3
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,37 @@
# DDR Card Draw

App by Jeff Lloyd, ported to react by me for ease of development.
This is web-app that allows random draw of songs from Dance Dance Revolution (both Ace and Extreme)
with a variety of optional conditions, primarially around difficulty level. The primary use case is
for competitive tournaments, but it may also be useful as a training tool.

Pre-built, standalone ZIP files are available for download on the [releases page](https://github.com/noahm/DDRCardDraw/releases)
The app is officially available at [https://ddrdraw.surge.sh/](https://ddrdraw.surge.sh/)
or as a downloadable zip file from the [releases page](https://github.com/noahm/DDRCardDraw/releases).
The app is designed such that even the online version will work without any internet connection after
being loaded once in any modern web browser.

## Developing
Original app by Jeff Lloyd; ongoing maintenance provided by [noahm](https://github.com/noahm)
and [FuriousDCSL](https://github.com/FuriousDCSL). Contributions are welcome!

```
## Customizing
This app can be easily customized for any special needs a tournament might have, including adding song
data for other games. If you have requests or ideas, [please reach out](https://m.me/noah.manneschmidt)!

If you want to take a stab at it yourself, you will want to have node.js >= 8.0.0 installed and some
familarity with [Preact](https://github.com/developit/preact) (or react) apps.

Clone this repo, and then the following commands will be useful:

```sh
# one time install of dependencies
npm install

# local development
# local development will start, with app running at http://localhost:8080/
# edits to the files in src will be reflected in real time
npm start

# double check changes to song list in ./src/songs/ace.json
# double check any changes made to song lists in ./src/songs/
npm run validate

# output static site to ./dist
# build a zipped, standalone copy of the app
npm run build
```

0 comments on commit 0860ad3

Please sign in to comment.