Skip to content

docs: enhance README with project structure and development setup #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ChatsworthStClair wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: enhance README with project structure and development setup #202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,31 @@
# Game Master Monorepo

## Under Construction
It became clear that the game master project would benefit from a monorepo setup to share API logic between the dedicated handler and the Remix client. Currently under construction.
A Dungeons & Dragons campaign management tool with a Phoenix/Elixir backend and React/TanStack frontend.

## Project Structure

This monorepo uses `pnpm` workspaces and Turbo for build orchestration:

- **packages/** - Shared packages and utilities
- **apps/** - Application services (API handler, Remix client)

The separation enables code sharing between the API and frontend while maintaining clean package boundaries.

## Development

Install dependencies:
```bash
pnpm install
```

Run development servers:
```bash
pnpm dev
```

Run tests:
```bash
pnpm test
```

See individual package READMEs for more detailed setup.