iamlogand / republic-of-rome-online Goto Github PK

The README file is too verbose and contains information that doesn't belong there. To fix this, make it more concise and move the details about setting up a local development environment to the wiki.

The account button in the top bar has a fixed width, which makes no sense considering that account names can be anywhere from 1-50 characters long.

Related to #56

Trajan is on-theme, but using it everywhere is a bit much. In most places, use a more readable/normal sans serif font like Gill Sans. Trajan should still be used for certain things, like names and larger text.

To solve the problem of dealing with overflowing text content in the UI, I already made a function that shortens strings and appends an ellipsis. Try replacing this with the text-overflow: ellipsis CSS property.

Also implement this on the topbar account button because usernames can be up to 150 characters long.

Related to #50

Not much of a bug but rather an oversight that should be corrected.

The game entity's owner property is currently optional at the model-level. It should be set to required instead, because there is no logical reason for a game to exist without an user to take ownership of it from the moment they create it.

Create React App is no longer recommended by React. Switch to Next.js.

This should be as simple as creating a new Next.js app, then copying the source files and dependencies over.

EDIT: It wasn't!

For the sign in form, currently the user must actually click the submit button using their mouse. Pressing the enter key just closes the form, which is bad

Make the Senator Inspector able to support varying content dimensions determined after the content has been rendered, rather than before, without spilling over the edge of the page. This change will give the Senator Inspector the freedom to contain more dynamic content.

This can probably be done by converting the existing SenatorInspector component into two components: container and content. Once the content component is initially renderred it can access it's own dimensions through getBoundingClientRect(). The content component can then pass it's dimensions to the container component by setting the container's state, using state setters passed as props. Once these states are changed, the container will redetermine where to position itself using the updated state values. Ideally this will not create an infinite rerender loop because the content component will not actually change at any point since the initial render so React will not rerender it.

The API already supports this, so the only changes needed are in the frontend.

Tasks:

• Add a page at "/games/123/edit" titled "Edit game".
• Add an edit button to the game lobby.
• Add the current description to the edit game page.
• Add a form with a new description field, complete with a submit button. The field should submit a PATCH request because only one field on the Game model is being updated.

It would be useful if token resources appeared here:

It's annoying having to pass token (and username) getters and setters down the component tree to every component that needs to access the API. Implement React Contexts to simplify access to these getters and setters since they are used so ubiquitously.

This console warning pops up whenever the "your account" page is accessed - fix it.

Using the modal for the sign in looks good, but making every page handle it's potential presence is annoying, so it's not worth it.

The redirect sign in page could still take the user back to the page they tried to access on successful submission, perhaps using some high level state that saves the last URL.

Part of #43

Introduce game participants - users who have joined a game.

API changes:

• Create a GameParticipant model, which will represent many-to-many relationships between Game and User instances.
• Update the Game create method to also create an instance of GameParticipant, making game owners participants by default upon game creation.
• Update the Game read collection method to include a list of participating usernames in the response.

UI changes:

• Add a participant count column to the game list page.
• Add a mouseover text box showing a list of participant usernames.

This approach allows separation of responsibilty at the model level for describing participation and ownership. This could be useful in a future version if the owner is given more advanced ownership-related operations, such as: not participating in their own game, leaving their own game, or transferring ownership to another user.

As well as showing the unrest level, we should show the forecasted chance (%) of the senate being overthrown when the people revolt. This would help communicate to the players when there is a significant danger of players being defeated.

Move the Python backend application into a Docker container. This will greatly increase parity of the development and production environments. Another benefit is that infrastructure configurations would be moved out of AWS and into the codebase, which makes future infrastructure changes easier to make (because AWS sucks).

Use a blue/green deployment strategy.

Steps

• Create a decoupled clone of the existing blue environment's coupled DB.
• In a new git branch, make necessary code changes to migrate the backend and it's configurations to Docker, whilst using the existing local DB. Ensure that the app works locally when running in Docker Desktop.
• Create a new Docker production environment in AWS with no coupled DB. This is the green environment.
• Edit the GitHub backend deployment workflow to target the green environment, with configurations that correspond to the decoupled clone of the production environment.
• Deploy to the green environment.
• That previous step will probably fail, so make incremental fixes until the green environment is operational.
• Configure the domain in Route53 to point at the green environment.
• Update the Wiki

Anticipated challenges

• SSL/TLS, because it relies on the domain being "roronline.com" to test whether it's working. It's impossible to ensure that SSL works with the green environment without actually testing it by pointing the domain at it. It will almost certainly not work right away, and will require fixes. In the meantime, the website will be down. However, this doesn't actually matter at all because there are 0 users.

Currently, when a user's refresh token expires, they are signed out and sent to the home page, right back to square one, with no indication of what happened.

Instead, when this happens, the user should be informed that their session has expired.

Tasks

• #46
• #52
• #51
• #79
• #92
• #96
• #102
• #103
• #104

Part of #43

Inform user that a game he is viewing got deleted and offer him a way to get back to the games page.

Currently existing users can sign in, but new users can't register. The only way to create a new account is through the Django admin console.

Make the user registration page functional. This will involve procuring an email server for email verification.

Users should be able to view a list of games.

Tasks:

• Update the game serializer and view so the API exposes more game attributes
• Add a list page to the UI to display this information

• API change: add method for game singleton deletion - must succeed only if sender is owner, otherwise return 403
• UI change: add delete button and confirmation modal for deletion

The User collection resource is currently located at /user/, which is unconventional because the singular "user" is being used. This should be changed to "users".

The same issue exists for token resources.

It would be worth learning more about REST naming conventions and fixing anything that looks unconventional.

https://create-react-app.dev/docs/adding-typescript/

Add a unit test to the backend using Django’s test-execution framework and REST framework's test classes.

Add attributes to the backend game model:

• Owner
• Description
• Creation date
• Start date

Add reference to this being fan made to both the landing page and the readme

Description of problem:
When using the VS Code "run and debug" to start the app, it opens in two windows.

Expected behavior:
The app opens in one window.

Add a join waitlist form to the home page.

Steps:

• Add a new Django model for waitlist submissions
  • Model should have two fields: email address and submission date
• Add a Django REST Framework (DRF) API serializer and viewset for creating instances of this model
• Add a form to the UI that consumes this API method
  • Form should have one field: email address

Currently, after game creation, the user is redirected to the game list page. Instead, redirect to the relevant game page.

The senator portrait shown within the senator inspector shouldn't have a dark border, because it's not a clickable button. This border should be removed when it's in the inspector.

It would be useful if users could see live changes to the participant list whilst they are on the game page without having to refresh the page. Implement web sockets to meet this requirement.

Currently a game can be deleted with a single click. Add a confirmation step to prevent accidental deletion.

Improve the initial load time of the game list page.

Part of #43

• API changes
  • Update the Game collection resource GET method to include game IDs in the response.
  • Add a Game singleton resource.
• UI changes
  • Add a game "Dashboard" page where users can see info about any one game. This page will use a new URI pattern that includes the game ID. This page will consume the new API Game singleton resource.
  • Add buttons to the game list that use IDs to navigate to relevant dashboard pages.

Symptom

Trying to create a new game doesn't work anymore. With the Chrome dev tools console open, I can see that it's caused by a 500 internal server error in the console. This error is thrown with every click of the "Create" button.

Cause

It looks like this bug was introduced in #115 when host was accidentally renamed to owner in the Serializer during a merge conflict resolution - see the change here. For context, "owner" was the original name, but it was changed to "host" a couple of weeks ago.

Stop owners/hosts from being able to leave their own game. This needs to be enforced by the API and the UI.

Create a non-functional mockup for some parts of the in-game UI.