@@ -5,21 +5,17 @@ Overview
55- Participants complete the Cypher TODOs in ` db.py ` to enable user auth, chat creation, and viewing history.
66- OpenAI is used to generate assistant replies; reads config from environment variables.
77
8- Quick Start
9- - Python 3.9+
10- - Install dependencies:
11- - uv: ` uv sync `
8+ Quick Start with Codespaces
9+ - Create an account on https://console-preview.neo4j.io/ and create a free Aura instance (make sure to save the password).
10+ - In the GitHub repository click the green "Use this template" button and open the project in a codespace.
1211- Copy ` .env.example ` to ` .env ` and set values.
13- - Run: ` python app.py `
14-
15- Environment Variables
16- - ` NEO4J_CONNECTION_URI ` : Neo4j Connection URI (copy from your Aura instance).
17- - ` NEO4J_USERNAME ` / ` NEO4J_PASSWORD ` : (default username: neo4j, paste password that you get during the instance creation).
18- - ` OPENAI_API_KEY ` : API key for OpenAI
19- - ` OPENAI_BASE_URL ` : https://api.openai.com/v1 (no need to change)
12+ - ` NEO4J_CONNECTION_URI ` : Inspect your Aura instance and copy the connection URI.
13+ - ` NEO4J_PASSWORD ` : (paste password that you got during the instance creation).
14+ - Open the Run and Debug menu and start the "Flask: run app.py" configuration.
15+ - It opens a terminal and starts the Flask development server, click on the link to open the app in a new browser tab.
16+ - Try registering a new user, you should see Cypher Error page which means you're ready to start the exercises!
2017
2118Workshop Tasks (Cypher TODOs in ` db.py ` )
22- - Create an account on https://console-preview.neo4j.io/ and create a free Aura instance.
2319- Create/Login User
2420 - ` create_user(username, password_hash) ` : create a ` :User ` with properties and return it.
2521 - ` fetch_user_by_username(username) ` : find a ` :User ` by username and return it.
3531- ` /chat/new ` : start a new chat by sending the first message.
3632- ` /chats ` : list previous chats.
3733- ` /chats/<chat_id> ` : view and continue a chat.
38-
39- Safety and Dev Tips
40- - Do not commit secrets. Use ` .env ` locally.
41- - Hash passwords; never store plain text. We use ` werkzeug.security ` .
42- - For production, set a strong ` FLASK_SECRET_KEY ` and configure HTTPS.
0 commit comments