Skip to content
Open
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
Binary file added .DS_Store
Binary file not shown.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@

server for code genie

## Team Members
- Basel Amin
- Mohammad Shaheen
- Hasan Masalha
- Aya Abbas
- Shaden Hakim

## Product Goal
This Code Genie server is the server for the Telegram bot named Code Genie. It designed to help graduates continue their studies and stay committed to practicing even after graduation

## General Architecture
This project includes the following main modules:
- Routes
- Database
- Business Logic: OpenAI

![Alt text](images/diagram.png)

# folder structure for the project

code-genie-server/
Expand All @@ -16,7 +34,8 @@ server for code genie
├── requirements.txt # Python dependencies
└── README.md # Project documentation

---
## Environment Variables


# Environment Variables (Explanation)

Expand All @@ -28,7 +47,7 @@ The following environment variables are stored in `.env`. Loading and usage of t
- `OPENAI_API_KEY`: The API Key used to make requests to the OpenAI API. Example: **sk-abcdefghijklmnopqrstuvwxyz1234567890abcd**
- `SERVER_URL`: The online server url. Example: **https://online-server-url.onrender.com/**

# Environment Variables (Usage)
### Environment Variables - Usage

To load environment variables from a `.env` file in Python, you can use the `python-dotenv` package. Here’s how you can do it:

Expand Down
Binary file added images/diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.