Skip to content

Commit

Permalink
Update README to include socket.io docs
Browse files Browse the repository at this point in the history
  • Loading branch information
archessmn committed Oct 18, 2024
1 parent 83d9ada commit ea88ac6
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,21 @@ Open [http://localhost:3000](http://localhost:3000) or [https://localhost:3000](

To get admin permissions, sign in once with Google, then run `yarn do promoteUser <your email>`.

## Development

There are some docs written for developing specific features but otherwise looking at the code and the [Next.js documentation](https://nextjs.org/docs) is the best place to get started.

Feature specific docs:

- [Socket.io communication](/docs/development/implementing_socket_io.md)

## Structure

- app/ - pages
- features/ - business logic functinality
- lib/ - low level utilities (auth, db, etc.)
- server/ - custom server that handles socket.io communication

## Development
## Issue Tracking

We use [Linear](https://linear.app/ystv) to track issues - to access it, sign in with your @ystv.co.uk Google account (ask a Computing Team member if you don't have one).

0 comments on commit ea88ac6

Please sign in to comment.