Skip to content

Commit 99c33c4

Browse files
committed
[main]: update env sample and gitignore
1 parent b16afad commit 99c33c4

6 files changed

Lines changed: 72 additions & 112 deletions

File tree

.gitignore

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# --- Environment & Secrets ---
2+
.env**
3+
*.local
4+
!.env.sample
5+
6+
# --- Editor & OS ---
7+
.vscode/*
8+
!.vscode/extensions.json
9+
.idea/
10+
.DS_Store
11+
*.suo
12+
*.ntvs*
13+
*.njsproj
14+
*.sln
15+
*.sw?
16+
.#*
17+
.project
18+
.pydevproject
19+
.ropeproject
20+
.mr.developer.cfg
21+
22+
# --- Global Tooling ---
23+
node_modules/
24+
dist/
25+
dist-ssr/
26+
logs/
27+
*.log
28+
npm-debug.log*
29+
yarn-debug.log*
30+
yarn-error.log*
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
ENVIRONMENT="local"
2-
GEMINI_API_KEY="XYZ"
32
API_PREFIX = "/api/v1"
43
PORT=8002
54
DATABASE_URI="mongodb://<username>:<password>@127.0.0.1:27017/tz-fabric?authSource=admin&retryWrites=true&w=majority"
65
GROQ_API_KEY="gsk_xxxxxxxxxxxxxxxxxxxxxxxxx"
76

87
#for production
8+
AWS_ARN="arn:aws:iam::012345678901:user/<whoever>"
99
AWS_ACCESS_KEY_ID="****"
1010
AWS_SECRET_ACCESS_KEY="***"
1111
AWS_REGION="ap-south-1"
1212
AWS_BUCKET_NAME="bucket-name"
13-
14-
CDN_URL="https://cdn.example.com"
13+
CDN_URL="https://cdn.example.com"
14+
STORAGE_DRIVER="s3" // could be "local" for development

backend/.gitignore

Lines changed: 26 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,28 @@
1-
# Byte-compiled / optimized / DLL files
1+
# --- Python Byte-code ---
22
__pycache__/
33
*.py[cod]
4-
.streamlit/
5-
.venv
6-
.mypy_cache*
7-
min
8-
# C extensions
4+
*$py.class
95
*.so
10-
.env**
11-
!.env.local
12-
# Distribution / packaging
6+
7+
# --- Poetry & Virtual Envs ---
8+
.venv/
9+
.python-version
10+
.mypy_cache/
11+
.pytest_cache/
12+
13+
# --- LanceDB & Data (Specific to your AI work) ---
14+
*.lance
15+
_deletion/
16+
_transactions_/
17+
_versions_/
18+
data/
19+
vector_store/
20+
assets/
21+
22+
# --- Build & Distribution ---
1323
bin/
1424
build/
1525
develop-eggs/
16-
dist/
1726
eggs/
1827
lib/
1928
lib64/
@@ -23,87 +32,20 @@ var/
2332
*.egg-info/
2433
.installed.cfg
2534
*.egg
26-
27-
# LanceDB artifacts
28-
*.lance
29-
_deletion/
30-
_transactions_/
31-
_versions_/
32-
data/
33-
34-
# Installer logs
35-
pip-log.txt
36-
pip-delete-this-directory.txt
37-
38-
# Unit test / coverage reports
39-
.tox/
40-
.coverage
41-
.cache
42-
nosetests.xml
43-
coverage.xml
44-
45-
# misc
46-
.DS_Store
47-
48-
# Translations
49-
*.mo
50-
51-
# Mr Developer
52-
.mr.developer.cfg
53-
.project
54-
.pydevproject
55-
56-
# Rope
57-
.ropeproject
58-
59-
# Django stuff:
60-
*.log
61-
*.pot
62-
63-
# Sphinx documentation
64-
docs/_build/
65-
.venv/**
66-
67-
node_modules/**
68-
69-
# PyInstaller
70-
# Usually these files are written by a python script from a template
71-
# before PyInstaller builds the exe, so as to inject date/other infos into it.
72-
#*.manifest
7335
*.spec
36+
target/
7437

75-
76-
# Unit test / coverage reports
77-
htmlcov/
38+
# --- Testing & Coverage ---
7839
.tox/
7940
.coverage
8041
.coverage.*
8142
.cache
8243
nosetests.xml
8344
coverage.xml
84-
*,cover
85-
86-
# Translations
87-
*.mo
88-
*.pot
89-
90-
# Django stuff:
91-
*.log
92-
93-
# Sphinx documentation
94-
docs/_build/
95-
96-
# PyBuilder
97-
target/
98-
99-
# Emacs
100-
.#*
101-
!.flake8
45+
htmlcov/
10246

103-
# Notebook Checkpoints
47+
# --- Misc ---
48+
.streamlit/
10449
.ipynb_checkpoints/
105-
assets/
106-
vector_store/
107-
.env
108-
/backend/assets/
109-
/backend/vector_store/
50+
docs/_build/
51+
!.flake8

frontend/.env.sample

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
VITE_API_URL="http://localhost:8000"
22
VITE_API_PREFIX="/api/v1"
3-
DATABASE_URI="mongodb://<user>:<password>127.0.0.1:27017/tz-fabric?authSource=admin&retryWrites=true&w=majority"
43
GROQ_API_KEY="your_groq_key_here"
54
VITE_AWS_PUBLIC_URL="https://<bucket>.s3.amazonaws.com"

frontend/.gitignore

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,12 @@
1-
# Logs
2-
logs
3-
*.log
4-
npm-debug.log*
5-
yarn-debug.log*
6-
yarn-error.log*
7-
pnpm-debug.log*
8-
lerna-debug.log*
9-
.env**
1+
# --- Framework Specific (Astro/React/Next) ---
2+
.astro/
3+
.next/
4+
out/
105

11-
node_modules
12-
dist
13-
dist-ssr
14-
*.local
6+
# --- Build Artifacts ---
7+
# 'dist' is handled by root, but you can be explicit here
8+
dist/
159

16-
# Editor directories and files
17-
.vscode/*
18-
!.vscode/extensions.json
19-
.idea
20-
.DS_Store
21-
*.suo
22-
*.ntvs*
23-
*.njsproj
24-
*.sln
25-
*.sw?
10+
# --- Local Tooling ---
11+
.pnpm-debug.log*
12+
lerna-debug.log*

frontend/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ npm install
77
npm run dev
88
```
99

10-
Note: create `.env` file and set the `VITE_API_URL` and it should be same as _vite.config.ts_
10+
Note: create `.env` file and put content from `.env.sample` file
11+
12+
NOTE: the `VITE_API_URL` and it should be same as _vite.config.ts_

0 commit comments

Comments
 (0)