From 35e97686089d2a1368ea1bc0657e08b4db681a58 Mon Sep 17 00:00:00 2001 From: Veirt Date: Mon, 25 Nov 2024 16:43:38 +0800 Subject: [PATCH] docs: update README with tech stack and environment variables --- README.md | 19 +++++++++++++++++++ docker-compose.yml | 2 ++ 2 files changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d025d89 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +## Tech Stack + +- **Express.js**: Web framework for building REST APIs. +- **Drizzle**: An ORM (Object-Relational Mapping) tool that simplifies interactions with the PostgreSQL database. +- **Google Cloud Storage**: Used for storing profile pictures and chat images. +- **Firebase Realtime Database**: Real-time database for managing user interactions between learners and tutors. + +## Environment Variables + +The application requires the following environment variables to be set: + +- `FIREBASE_SERVICE_ACCOUNT_KEY`: JSON string containing the Firebase service account key. +- `FIREBASE_DATABASE_URL`: URL of the Firebase Realtime Database. +- `GCS_BUCKET_NAME`: Google Cloud Storage bucket name for storing images. +- `DATABASE_URL`: PostgreSQL database connection URL. +- `JWT_SECRET`: Secret key for signing JWT tokens used for authentication. +- `GROQ_KEY`: API key for Groq, used to generate teaching methodologies for tutors. Only necessary if you are running the seeders. + +See [Development Guide](docs/development-guide.md) and [Common Issues](docs/common-issues.md) for more information. diff --git a/docker-compose.yml b/docker-compose.yml index 1040817..039573c 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -8,4 +8,6 @@ services: - FIREBASE_SERVICE_ACCOUNT_KEY= - FIREBASE_DATABASE_URL= - GCS_BUCKET_NAME= + - DATABASE_URL= + - JWT_SECRET= restart: on-failure:5