Skip to content

feat(docs): add testing instructions to docs #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hoangsonww merged 2 commits into from
Jul 5, 2025
Merged

feat(docs): add testing instructions to docs #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af54743
Update: Added K8s & Jenkins CI/CD
hoangsonww Jul 5, 2025
5526736
Update: Added K8s & Jenkins CI/CD
hoangsonww Jul 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ Welcome to the **E-Learning Management System (LMS)**! This project consists of
- [MongoDB Atlas](#mongodb-atlas)
- [Containerization](#containerization)
- [Kubernetes](#kubernetes)
- [Testing](#testing)
- [Backend Tests](#backend-tests)
- [Frontend Tests](#frontend-tests)
- [OpenAPI Specification](#openapi-specification)
- [Jenkins CI/CD](#jenkins-cicd)
- [Troubleshooting](#troubleshooting)
Expand Down Expand Up @@ -164,8 +167,7 @@ The backend is deployed on Render: **[Backend API](https://learning-management-s

Feel free to explore the platform, create an account, and test out the features!

> [!IMPORTANT]
> **Note:** Our backend server may spin down due to inactivity, so you may experience delays in loading data initially as the backend is hosted on the free tier of Render. If you encounter any issues, please let me know.
> [!IMPORTANT] > **Note:** Our backend server may spin down due to inactivity, so you may experience delays in loading data initially as the backend is hosted on the free tier of Render. If you encounter any issues, please let me know.

## Detailed Project Information:

Expand Down Expand Up @@ -834,6 +836,34 @@ To deploy the applications to a Kubernetes cluster, follow these steps:

The above commands will create the deployments and services for the backend and frontend applications. You can access the applications using the NodePort or LoadBalancer service IP addresses.

## Testing

The project includes unit tests for both the backend and frontend applications. You can run the tests using the following commands:

### Backend Tests

To run the backend tests, navigate to the `LMS-Backend` directory and run:

```bash
cd LMS-Backend

pytest -q
```

### Frontend Tests

To run the frontend tests, navigate to the `LMS-Frontend/app` directory and run:

```bash
cd LMS-Frontend/app

# Run tests (normal mode)
npm run test

# Run tests (code coverage mode)
npm run coverage
```

## OpenAPI Specification

### Using the `openapi.yaml` File
Expand Down
Loading