robert/ttrpg-initiative-tracker
1
0
Fork 0
Code Pull Requests Releases 2 Wiki Activity

More readme cleanup.

Browse Source
This commit is contained in:
Robert Johnson 2025-05-26 10:31:04 -04:00
parent c6cb37835f
commit 42d70f0817
1 changed files with 98 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,5 +1,9 @@
# TTRPG Initiative Tracker
This application is the result of not having the exact tool I want to use, and a few sessions of [vibe-coding](https://www.youtube.com/watch?v=Tw18-4U7mts) with [Google Gemini](https://developers.google.com/gemini-code-assist/docs/overview).
**Use at your own risk.**
A web-based application designed to help Dungeon Masters (DMs) manage and display combat initiative for tabletop role-playing games (TTRPGs). It features a DM admin interface for controlling encounters and a separate player display view suitable for an external monitor or for players to view on their own devices.
## Features
@ -70,13 +74,13 @@ This flow allows the DM to prepare and run encounters efficiently while providin
### Local Development Setup (using npm)
1. **Clone the Repository:**
#### **Clone the Repository:**
```bash
git clone <your-repository-url>
cd ttrpg-initiative-tracker
```
2. **Create Firebase Configuration File (`.env.local`):**
#### **Create Firebase Configuration File (`.env.local`):**
* In the root of the project, create a file named `.env.local`.
* Add your Firebase project configuration details to this file. You can find these in your Firebase project settings (Project settings > General > Your apps > Firebase SDK snippet > Config).
* **Important:** This `.env.local` file contains sensitive API keys and should **NOT** be committed to Git. Make sure it's listed in your `.gitignore` file.
@ -95,14 +99,14 @@ This flow allows the DM to prepare and run encounters efficiently while providin
```
*An `.env.example` file is included in the repository as a template.*
3. **Install Dependencies:**
#### **Install Dependencies:**
Navigate to the project root in your terminal and run:
```bash
npm install
```
This will install all the necessary packages defined in `package.json` and create a `package-lock.json` file.
4. **Set up Firestore Security Rules:**
#### **Set up Firestore Security Rules:**
* Go to your Firebase project console -> Firestore Database -> Rules.
* Use the following rules for development (allows authenticated users to read/write all data). **For production, you MUST implement more restrictive rules.**
```
@ -117,11 +121,11 @@ This flow allows the DM to prepare and run encounters efficiently while providin
```
* Publish these rules.
5. **Enable Anonymous Authentication:**
#### **Enable Anonymous Authentication:**
* In your Firebase project console -> Authentication -> Sign-in method.
* Enable "Anonymous" as a sign-in provider.
6. **Run the Development Server:**
#### **Run the Development Server:**
```bash
npm start
```
@ -141,6 +145,7 @@ This project includes a `Dockerfile` to containerize the application for deploym
* **Security Warning:** The image built this way will contain your Firebase API keys from `.env.local`. **Do NOT push this specific image to a public Docker registry.** For production, environment variables should be injected by your hosting platform or CI/CD pipeline at build or runtime.
To build the image, navigate to the project root and run:
```bash
docker build -t ttrpg-initiative-tracker .
```
@ -159,6 +164,7 @@ This project includes a `Dockerfile` to containerize the application for deploym
You can then access the application at `http://localhost:8080`.
**4. Production Deployment Considerations:**
* When deploying to a production environment (e.g., a cloud provider, your own server), you should **not** copy your `.env.local` file into the Docker image.
* Instead, configure the `REACT_APP_FIREBASE_...` environment variables directly in your hosting platform's settings or pass them to the Docker container at runtime (if your application is set up to read them at runtime, though Create React App bakes them in at build time).
* If your CI/CD pipeline builds the Docker image, ensure these environment variables are securely provided to the build environment.
@ -166,7 +172,24 @@ This project includes a `Dockerfile` to containerize the application for deploym
## Project Structure
ttrpg-initiative-tracker/├── .dockerignore # Specifies intentionally untracked files that Docker should ignore├── .env.example # Example environment variables├── .env.local # Local environment variables (ignored by Git)├── .gitignore # Specifies intentionally untracked files that Git should ignore├── Dockerfile # Instructions to build the Docker image├── package-lock.json # Records exact versions of dependencies├── package.json # Project metadata and dependencies├── postcss.config.js # PostCSS configuration (for Tailwind CSS)├── tailwind.config.js # Tailwind CSS configuration├── public/ # Static assets│ ├── favicon.ico│ ├── index.html # Main HTML template│ └── manifest.json└── src/ # React application source code├── App.js # Main application component├── index.css # Global styles (including Tailwind directives)└── index.js # React entry point
`ttrpg-initiative-tracker/`
- ` .dockerignore` # Specifies intentionally untracked files that Docker should ignore
- ` .env.example` # Example environment variables
- ` .env.local` # Local environment variables (ignored by Git)
- ` .gitignore` # Specifies intentionally untracked files that Git should ignore
- ` Dockerfile` # Instructions to build the Docker image
- ` package-lock.json` # Records exact versions of dependencies
- ` package.json` # Project metadata and dependencies
- ` postcss.config.js` # PostCSS configuration (for Tailwind CSS)
- ` tailwind.config.js` # Tailwind CSS configuration
- ` public/` # Static assets
- ` favicon.ico`
- ` index.html` # Main HTML template
- ` manifest.json`
- ` src/` # React application source code
- ` App.js` # Main application component
- ` index.css` # Global styles (including Tailwind directives)
- ` index.js` # React entry point
## Contributing