Skip to content

docs: update project title, links, and test examples in server README #7

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

Open
coder11v wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −6
Open

docs: update project title, links, and test examples in server README #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# EVALUABLE AI
# Google Stax Server

## Table of Contents

Expand All @@ -8,12 +8,12 @@
- [Running the Application](#running-the-application)
- [Running Tests](#running-tests)
- [API Documentation](#api-documentation)
- [App specifics](/docs/README.MD)
- [App specifics](docs/README.md)
- [License](#license)

## Running the application

You can checkout the instructions on how to directly run the application within a container [here](/docs/LOCAL_SETUP.md)
You can checkout the instructions on how to directly run the application within a container [here](docs/LOCAL_SETUP.md)

## Prerequisites for manual setup

Expand Down Expand Up @@ -106,15 +106,15 @@ This project uses JUnit for testing. To run the tests, you can use the following
```
For example:
```
mvn test -Dtest=com.planck.planck.service.EvaluableKeysServiceTest
mvn test -Dtest=com.planck.planck.domain.workbook.WorkbookServiceTest
```
3. Run a specific test method:
```
mvn test -Dtest=TestClassName#testMethodName
```
For example:
```
mvn test -Dtest=com.planck.planck.service.EvaluableKeysServiceTest#testGenerateNewEvaluableKey_Success
mvn test -Dtest=com.planck.planck.domain.workbook.WorkbookServiceTest#testCreateWorkbook_Success
```
4. Run tests with coverage report (using JaCoCo):
```
Expand All @@ -127,4 +127,4 @@ This project uses JUnit for testing. To run the tests, you can use the following
```

## App specifics
We are handling Enums and Tagging in a specific way - for more info please check out this [doc](/docs/README.MD)
We are handling Enums and Tagging in a specific way - for more info please check out this [doc](docs/README.md)