Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Monorepo for the Cogniro project.

## Documentation

- [Technical documentation](docs/TECHNICAL-DOCUMENTATION.md) - architecture, technology stack, security and authentication, and the persistence and concurrency model.
- [Deployment guide](docs/DEPLOYMENT.md) - step-by-step setup and run instructions, with and without Docker, including all environment variables.

## Structure

```text
Expand All @@ -12,7 +17,7 @@ cogniro/

## Prerequisites

- [Node.js](https://nodejs.org/) (v20+)
- [Node.js](https://nodejs.org/) 22
- [pnpm](https://pnpm.io/) 10+
- [Python](https://www.python.org/) (>=3.14)
- [uv](https://docs.astral.sh/uv/) (for backend)
Expand Down
6 changes: 6 additions & 0 deletions backend/.env.example
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Copy to .env and fill in real values. Never commit .env.

# Deployment stage. Accepts ENVIRONMENT or ENV; defaults to "development".
# Any value other than development/dev/local/test is treated as production: the app then
# refuses to start if ADMIN_PASSWORD_HASH or JWT_SECRET is missing (instead of only warning).
# Set this to production for real deployments so misconfigured auth fails fast.
# ENVIRONMENT=production

# --- Admin auth (POST /admin/auth/login) ---
# Generate a bcrypt hash locally, then paste only the hash here:
# uv run python scripts/hash_admin_password.py
Expand Down
Loading
Loading