vtdung23 commited on
Commit
f31c75b
·
1 Parent(s): dced78a

Update QUICKSTART

Browse files
Files changed (3) hide show
  1. .gitignore +38 -0
  2. .vscode/settings.json +2 -1
  3. QUICKSTART.md +25 -5
.gitignore ADDED
@@ -0,0 +1,38 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Virtual Environment
2
+ env/
3
+ venv/
4
+ .env/
5
+ .venv/
6
+
7
+ # Python
8
+ __pycache__/
9
+ *.py[cod]
10
+ *$py.class
11
+ *.so
12
+ .Python
13
+
14
+ # Database
15
+ *.db
16
+ *.sqlite3
17
+
18
+ # IDE
19
+ .idea/
20
+ .vscode/
21
+ *.swp
22
+ *.swo
23
+
24
+ # OS
25
+ .DS_Store
26
+ Thumbs.db
27
+
28
+ # Uploads & Generated files
29
+ app/static/uploads/wordclouds/*
30
+ !app/static/uploads/wordclouds/.gitkeep
31
+
32
+ # Logs
33
+ *.log
34
+
35
+ # Distribution / packaging
36
+ dist/
37
+ build/
38
+ *.egg-info/
.vscode/settings.json CHANGED
@@ -1,5 +1,6 @@
1
  {
2
  "python-envs.defaultEnvManager": "ms-python.python:conda",
3
  "python-envs.defaultPackageManager": "ms-python.python:conda",
4
- "python-envs.pythonProjects": []
 
5
  }
 
1
  {
2
  "python-envs.defaultEnvManager": "ms-python.python:conda",
3
  "python-envs.defaultPackageManager": "ms-python.python:conda",
4
+ "python-envs.pythonProjects": [],
5
+ "git.ignoreLimitWarning": true
6
  }
QUICKSTART.md CHANGED
@@ -2,19 +2,34 @@
2
 
3
  ## Installation
4
 
5
- 1. **Install dependencies:**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
  ```bash
7
  pip install -r requirements.txt
8
  ```
9
 
10
- 2. **Run the application:**
11
  ```bash
12
  python main.py
13
  ```
14
 
15
- 3. **Access the application:**
16
- # Nhớ kích hoạt môi trường trước
17
- conda activate ./env
18
  - Dashboard: http://localhost:8000
19
  - **Swagger API Docs: http://localhost:8000/docs** ⭐ (Show this to your teacher!)
20
  - ReDoc: http://localhost:8000/redoc
@@ -113,4 +128,9 @@ Close any other instances of the app and restart.
113
  ✅ **Responsive UI** (TailwindCSS)
114
  ✅ **Database Integration** (SQLite with history tracking)
115
 
 
 
 
 
 
116
  Good luck! 🎓
 
2
 
3
  ## Installation
4
 
5
+ 1. **Tạo môi trường ảo (Virtual Environment):**
6
+
7
+ **Option A - Dùng Conda:**
8
+ ```bash
9
+ conda create -p ./env python=3.10 -y
10
+ conda activate ./env
11
+ ```
12
+
13
+ **Option B - Dùng venv:**
14
+ ```bash
15
+ python -m venv env
16
+ # Windows:
17
+ env\Scripts\activate
18
+ # Linux/Mac:
19
+ source env/bin/activate
20
+ ```
21
+
22
+ 2. **Install dependencies:**
23
  ```bash
24
  pip install -r requirements.txt
25
  ```
26
 
27
+ 3. **Run the application:**
28
  ```bash
29
  python main.py
30
  ```
31
 
32
+ 4. **Access the application:**
 
 
33
  - Dashboard: http://localhost:8000
34
  - **Swagger API Docs: http://localhost:8000/docs** ⭐ (Show this to your teacher!)
35
  - ReDoc: http://localhost:8000/redoc
 
128
  ✅ **Responsive UI** (TailwindCSS)
129
  ✅ **Database Integration** (SQLite with history tracking)
130
 
131
+
132
+ Push lên GitHub: git push github main
133
+ Push lên Hugging Face: git push origin main
134
+ Push cả 2: git push github main && git push origin main
135
+
136
  Good luck! 🎓