Skip to content

Commit 9a93776

Browse files
committed
chore(docs): update README
1 parent f9e51ed commit 9a93776

1 file changed

Lines changed: 25 additions & 6 deletions

File tree

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/stormix/lgamila)
44
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/Stormix/lgamila?utm_source=oss&utm_medium=github&utm_campaign=Stormix%2Flgamila&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
55

6+
[![API Status](https://uptime.betterstack.com/status-badges/v1/monitor/22wjm.svg)](https://uptime.betterstack.com/?utm_source=status_badge)
7+
8+
[![Web Status](https://uptime.betterstack.com/status-badges/v1/monitor/22wjk.svg)](https://uptime.betterstack.com/?utm_source=status_badge)
9+
610
<div align="center">
711

812
![LGamila Logo](./apps/web/public/lgamila-live.svg)
@@ -64,6 +68,7 @@ This monorepo includes the following packages/apps:
6468

6569
- `@lgamila/shared`: Shared utilities and type definitions
6670
- `@lgamila/logging`: Structured logging with context support and Sentry integration
71+
- `@lgamila/design-system`: Shared UI components built with Radix UI and Tailwind CSS
6772
- `@lgamila/typescript-config`: TypeScript configurations
6873

6974
## Getting Started
@@ -94,11 +99,7 @@ This monorepo includes the following packages/apps:
9499

95100
3. **Set up environment variables:**
96101

97-
```bash
98-
cp .env.example .env
99-
```
100-
101-
Fill in the required environment variables in `.env` file.
102+
Create environment files for the backend and other apps as needed. Refer to the individual app README files for specific environment variable requirements.
102103

103104
4. **Set up the database:**
104105

@@ -123,6 +124,24 @@ This monorepo includes the following packages/apps:
123124
pnpm --filter extension dev # Browser extension
124125
```
125126

127+
## Development Commands
128+
129+
### Code Quality
130+
131+
```bash
132+
pnpm lint # Run linting across all packages
133+
pnpm format # Format code across all packages
134+
pnpm check-types # Type check all packages
135+
```
136+
137+
### Build Commands
138+
139+
```bash
140+
pnpm build # Build all packages
141+
pnpm --filter web build # Build only web app
142+
pnpm --filter extension build:all # Build extension for all browsers
143+
```
144+
126145
## Usage
127146

128147
### Backend API
@@ -135,7 +154,7 @@ The backend provides a REST API for accessing streamer data:
135154

136155
### Browser Extension
137156

138-
1. Build the extension: `pnpm --filter extension build:all`
157+
1. Build the extension using the command from the [Development Commands](#development-commands) section
139158
2. Load the extension in your browser:
140159
- **Chrome**: Load from `apps/extension/build/chrome-mv3-prod`
141160
- **Firefox**: Load from `apps/extension/build/firefox-mv2-prod`

0 commit comments

Comments
 (0)