Julian BILCKE
commited on
Update README.md to mention Git LFS
Browse files
README.md
CHANGED
|
@@ -54,13 +54,19 @@ Contributions are welcome to help supporting other platforms!
|
|
| 54 |
|
| 55 |
### Local Setup
|
| 56 |
|
| 57 |
-
1.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 58 |
```bash
|
| 59 |
git clone https://github.com/jbilcke-hf/FacePoke.git
|
| 60 |
cd FacePoke
|
| 61 |
```
|
| 62 |
|
| 63 |
-
|
| 64 |
|
| 65 |
Using a virtual environment (Python venv) is strongly recommended.
|
| 66 |
|
|
@@ -70,23 +76,23 @@ Contributions are welcome to help supporting other platforms!
|
|
| 70 |
pip3 install --upgrade -r requirements.txt
|
| 71 |
```
|
| 72 |
|
| 73 |
-
|
| 74 |
```bash
|
| 75 |
cd client
|
| 76 |
bun install
|
| 77 |
```
|
| 78 |
|
| 79 |
-
|
| 80 |
```bash
|
| 81 |
bun build ./src/index.tsx --outdir ../public/
|
| 82 |
```
|
| 83 |
|
| 84 |
-
|
| 85 |
```bash
|
| 86 |
python app.py
|
| 87 |
```
|
| 88 |
|
| 89 |
-
|
| 90 |
|
| 91 |
### Docker Deployment
|
| 92 |
|
|
|
|
| 54 |
|
| 55 |
### Local Setup
|
| 56 |
|
| 57 |
+
1. Make sure you have Git and Git LFS installed globally (https://git-lfs.com):
|
| 58 |
+
|
| 59 |
+
```bash
|
| 60 |
+
git lfs install
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
2. Clone the repository:
|
| 64 |
```bash
|
| 65 |
git clone https://github.com/jbilcke-hf/FacePoke.git
|
| 66 |
cd FacePoke
|
| 67 |
```
|
| 68 |
|
| 69 |
+
3. Install Python dependencies:
|
| 70 |
|
| 71 |
Using a virtual environment (Python venv) is strongly recommended.
|
| 72 |
|
|
|
|
| 76 |
pip3 install --upgrade -r requirements.txt
|
| 77 |
```
|
| 78 |
|
| 79 |
+
4. Install frontend dependencies:
|
| 80 |
```bash
|
| 81 |
cd client
|
| 82 |
bun install
|
| 83 |
```
|
| 84 |
|
| 85 |
+
5. Build the frontend:
|
| 86 |
```bash
|
| 87 |
bun build ./src/index.tsx --outdir ../public/
|
| 88 |
```
|
| 89 |
|
| 90 |
+
6. Start the backend server:
|
| 91 |
```bash
|
| 92 |
python app.py
|
| 93 |
```
|
| 94 |
|
| 95 |
+
7. Open `http://localhost:8080` in your web browser.
|
| 96 |
|
| 97 |
### Docker Deployment
|
| 98 |
|