Skip to content

Commit bd2a83a

Browse files
authored
Update README.md
1 parent 3b022c8 commit bd2a83a

1 file changed

Lines changed: 19 additions & 14 deletions

File tree

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,20 @@ Dr. Mehdi Hassan
3535
- Expand test coverage and error handling.
3636
- Finalize dashboard and reporting modules.
3737

38+
---
39+
## ⚙️ CI/CD Setup
40+
41+
Our CI/CD pipeline is designed for reliability and rapid iteration:
42+
43+
1. **GitHub Actions**
44+
- **Linting:** Runs ESLint and Prettier on every push and pull request.
45+
- **Testing:** Executes all unit and integration tests.
46+
- **Build:** Builds the backend and checks for dependency issues.
47+
- **Deployment:** (Planned) Auto-deploy to staging/production on successful main branch merges.
48+
49+
2. **Environment Variables**
50+
- All secrets and environment-specific configs are managed via `.env` files (excluded from git).
51+
3852
---
3953

4054
## 🛠 Developer Commands
@@ -46,6 +60,11 @@ Dr. Mehdi Hassan
4660
| `npm test` | Run all unit & integration tests in `app/tests` |
4761
| `npm install` | Install project dependencies |
4862

63+
> **Note:** Run the following command **before** executing any of the commands in the table above:
64+
> ```bash
65+
> cd VisionIndex-Backend/app
66+
> ```
67+
4968
---
5069
5170
🌐 Live Deployment
@@ -55,20 +74,6 @@ The backend is live and can be accessed at:
5574
5675
This deployment is fully CI/CD-driven — any successful merge to the main branch automatically triggers build and deployment.
5776
58-
---
59-
## ⚙️ CI/CD Setup
60-
61-
Our CI/CD pipeline is designed for reliability and rapid iteration:
62-
63-
1. **GitHub Actions**
64-
- **Linting:** Runs ESLint and Prettier on every push and pull request.
65-
- **Testing:** Executes all unit and integration tests.
66-
- **Build:** Builds the backend and checks for dependency issues.
67-
- **Deployment:** (Planned) Auto-deploy to staging/production on successful main branch merges.
68-
69-
2. **Environment Variables**
70-
- All secrets and environment-specific configs are managed via `.env` files (excluded from git).
71-
7277
---
7378
7479
## 🚀 VisionIndex Modules (Planned & In Development)

0 commit comments

Comments
 (0)