Skip to content

Commit

Permalink
Add roadmap and update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Soleone committed Sep 21, 2020
1 parent 8aad25e commit 5faad04
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,21 @@
A single page web app that helps Gods Unchained players share their challenge codes to play with each other.

- Live at https://gunchained.app
- View [changelog](https://github.com/Soleone/gunchained/blob/master/CHANGELOG.md).
- View [changelog](https://github.com/Soleone/gunchained/blob/master/CHANGELOG.md) for recent changes.
- View [roadmap](https://github.com/Soleone/gunchained/blob/master/ROADMAP.md) for potential future changes.
- Built using Vue, Vuetify, Vuex, DayJS.
- Backed by Firebase for authentication and storage
- Hosted for free using
- Might be extended eventually to have more than the Arena features for challenge codes.

## Contributing

Contributions and suggestions are always welcome. Please submit new issues at:
Contributions and suggestions are always welcome.

Please submit new issues at:
https://github.com/Soleone/gunchained/issues

Take a look at the [roadmap](https://github.com/Soleone/gunchained/blob/master/ROADMAP.md) document for ideas on what to work on.

### Project setup

Expand Down
68 changes: 68 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Roadmap

This document is a constant work in progress and can drastically change at any time.
It's more a collection of thoughts on where to take the project in which order.
Each of these would optimally be linked to an actual Github issue.
None of this is guaranteed to be worked on by anyone.

## Milestones

### 0.1.2

- See number of online users (recently logged in)

### 0.1.3

- Notifications when challenges are made available
- Browser notification API?

### 0.1.4

- Automatically expire availableSince after 12h
- [github example code](https://github.com/firebase/functions-samples/blob/master/delete-unused-accounts-cron/functions/index.js)

### 0.1.5

- Add Welcome page

### 0.2.0

- Public profile view (linked in published challenge)

### 0.3.0

- Detailed descriptions for Challenges and Player profiles
- Markdown
- Bold
- Italic
- Links
- Image links
- Lists?

### 0.4.0

- Set timezone and general availability

## Bugfixes

### High priority

### Low priority

- Fix login screen showing as empty card (polish)
- Bugfix: 404 hack causes browser warning and wayback machine link (polish)

## Ideas

- Users can send comments to available challenges' players to ask for status updates
- Requires inbox for players to receive these comments
- Player profile fields:
- Discord name (could be used to communicate about challenge status and general availability)
- Email
- Changing code should bump availableSince
- Challenge details
- God playing
- Deck name playing
- Matchup wanted (God, deck type)
- Decklist
- Announcement post? Voice?

0 comments on commit 5faad04

Please sign in to comment.