Skip to content

Commit

Permalink
Merge pull request #12 from PrasanthVijayy/graphQL/inventory
Browse files Browse the repository at this point in the history
Readme file updated
  • Loading branch information
PrasanthVijayy authored Oct 18, 2024
2 parents 0769771 + edb356a commit 244998b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,33 @@ To enhance performance and scalability, the system incorporates Redis for cachin
- [With Docker](#with-docker)
- [Running Tests](#running-tests)
- [API Documentation](#api-documentation)
- [API Collections](/API/API%20postmanCollection.json)

## Running the Application

### Locally

1. **Clone the Repository**:

```bash
git clone https://github.com/PrasanthVijayy/product-management-system.git
```

2. **Install Dependencies**:

```bash
npm install
```

3. **Create a `.env` File**:
Copy the example `.env` file and adjust the configuration as needed:

```bash
cp .env.example .env
```

4. **Run the Application**:

```bash
npm start
```
Expand All @@ -45,6 +50,7 @@ To enhance performance and scalability, the system incorporates Redis for cachin

1. **Build and Start Containers**:
Ensure Docker and Docker Compose are installed, then run:

```bash
docker-compose up --build
```
Expand All @@ -57,17 +63,20 @@ To enhance performance and scalability, the system incorporates Redis for cachin
## Running Tests

1. **Unit and Integration Tests**:
Folder for [Unit Test](/tests/restAPI/unitTesting/)
Folder for [Integration Test](/tests/restAPI/intergration/)

Run the following command to execute the test suite:

```bash
npm test
```

This will run all unit and integration tests defined in the `test` directory using Jest.

2. **Test Status**:
To view the test status and results in a more readable format, an HTML report is generated after test execution. You can open the generated HTML file to see a detailed view of the test results.
To view the test status and results in a more readable format, an HTML report is generated after test execution. You can open the generated HTML file to see a detailed view of the test results.
The HTML report is usually located in the `test/reports.html` file, and you can open it with any web browser.


## API Documentation

Expand Down
Loading

0 comments on commit 244998b

Please sign in to comment.