Skip to content

Commit

Permalink
docs(readme): small updates
Browse files Browse the repository at this point in the history
  • Loading branch information
emmenko committed Jan 20, 2018
1 parent 7f4cf9c commit 7a90cef
Showing 1 changed file with 6 additions and 17 deletions.
23 changes: 6 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,23 @@

# Tourname

[![Greenkeeper badge](https://badges.greenkeeper.io/emmenko/tourname.svg)](https://greenkeeper.io/)

A OSS service for managing tournaments within an organization.

## Background

You have a table tennis, a pool table, a table soccer (or something similar) in your office and you always wanted to keep track of the matches between you and your colleagues? With `tourname` you can do that!
Create your own tournaments and see who comes out on top, challenge a single player and see the leaderboard results.


## TODO
* ~~dataloader for queries optimization~~
* tests for resolvers
* ~~(social) login authentication~~
* ~~monorepo (server, client, natives)~~
* features
* ~~team matches (more than one player)~~
* single matches (1 vs 1, team vs team)
* allow to enter a custom "discipline", in case it's not listed as a default
* CI
* Documentation

## Development
_TBD_

```bash
$ yarn start
# - starts the backend server on port 3001
# - starts the web app on port 3000, using react-scripts
# - starts the backend server on port 3999
# - starts the web app on port 4000, using react-scripts
# - compiles reason -> js in watch mode
```

---
`<>` with `<3`
<h5 align="center">`< / >` with ❤️</h5>

0 comments on commit 7a90cef

Please sign in to comment.