Skip to content

Commit 537ae95

Browse files
committed
updated readme & did code enhancements
1 parent 36506ce commit 537ae95

9 files changed

Lines changed: 19 additions & 32 deletions

File tree

NoteMaker_Architecture.png

-12 KB
Loading

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,12 @@ Note Maker is not your average notes app. It provides you with the ability to ch
1212
- Embedding Model Provider: Google Generative AI Embeddings
1313
- Vector Store Hosting: Qdrant Cloud
1414
- Database: Aurora Postgres DB
15-
- Cache: Amazon ElastiCache
15+
- Hosted Redis Cache: Amazon ElastiCache
1616
- Backend Deployment: AWS Lambda
1717
- API Gateway: Amazon API Gateway
1818
- Authentication: API Gateway Authorizer with JWT
1919
- Frontend Hosting: Amazon S3
2020
- CDN: Amazon CloudFront
21-
- DNS: Route 53 DNS
2221

2322
### Run Locally
2423

@@ -33,28 +32,32 @@ Note Maker is not your average notes app. It provides you with the ability to ch
3332
GOOGLE_API_KEY=<add your key>
3433
QDRANT_URL=http://localhost:6333
3534
JWT_SECRET_KEY=supersecretkey
36-
```
35+
```
36+
3. install backend dependencies
37+
- `cd backend`
38+
- `pip install -r requirements.txt`
3739
38-
3. create tables
40+
4. create tables
3941
- `cd backend/setup_tables`
4042
- `python tables.py`
4143
42-
4. run ai_analyze_service
44+
5. run ai_analyze_service
4345
- `cd backend/ai_analyze_service`
4446
- `python app.py`
4547
46-
5. run auth_service
48+
6. run auth_service
4749
- `cd backend/auth_service`
4850
- `python app.py`
4951
50-
6. run notes_crud_service
52+
7. run notes_crud_service
5153
- `cd backend/notes_crud_service`
5254
- `python app.py`
5355
54-
7. run verify_token_service
56+
8. run verify_token_service
5557
- `cd backend/verify_token_service`
5658
- `python app.py`
5759
58-
7. run frontend
60+
9. run frontend
61+
- `npm install`
5962
- `cd frontend`
6063
- `npm run dev`

backend/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
__pycache__
2+
venv

backend/ai_analyze_service/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
DB_URL = os.getenv("DB_URL")
2626
GOOGLE_API_KEY = os.getenv("GOOGLE_API_KEY")
2727
QDRANT_URL = os.getenv("QDRANT_URL")
28-
QDRANT_API_KEY = os.getenv("QDRANT_API_KEY")
28+
QDRANT_API_KEY = os.getenv("QDRANT_API_KEY", None)
2929

3030
COLLECTION_NAME = "notes"
3131

backend/auth_service/requirements.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

backend/notes_crud_service/requirements.txt

Lines changed: 0 additions & 11 deletions
This file was deleted.

backend/notes_crud_service/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
REDIS_PORT = os.getenv("REDIS_PORT")
3131
GOOGLE_API_KEY = os.getenv("GOOGLE_API_KEY")
3232
QDRANT_URL = os.getenv("QDRANT_URL")
33-
QDRANT_API_KEY = os.getenv("QDRANT_API_KEY")
33+
QDRANT_API_KEY = os.getenv("QDRANT_API_KEY", None)
3434

3535
genai.configure(api_key=GOOGLE_API_KEY)
3636

backend/ai_analyze_service/requirements.txt renamed to backend/requirements.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,6 @@ langchain-groq
99
qdrant-client
1010
google-generativeai
1111
langchain-google-genai
12-
python-dotenv
12+
python-dotenv
13+
PyJWT
14+
redis

backend/verify_token_service/requirements.txt

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)