Skip to content

Commit

Permalink
Added some README content about starting a testing server.
Browse files Browse the repository at this point in the history
  • Loading branch information
eriq-augustine committed May 5, 2024
1 parent abe6a38 commit e9144df
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@ pip install autograder-py
## Running the Server

The main server is available via the `cmd/server` executable.
```
./bin/server
```

The `web.port` config option can be used to set the port the server listens on:
```
./bin/server -c web.port=80
Expand All @@ -159,6 +163,20 @@ The `setcap.sh` script will do this for you:
./setcap.sh
```

### Running the Server for Testing

You may want to run the server for testing/debugging,
e.g., if you are developing an interface to the server.
We recommend two additional changes to how you would normally run the server:
```
go run cmd/server/main.go --unit-testing
```

First, we ran the server using `go run`,
This will ensure that the server executable is up-to-date before running it.
Second we used the `--unit-testing` flag,
which will set some testing options, create a clean new database, and load the test courses (inside the `_tests directory).

## Running Tests

This repository comes with several types of tests.
Expand Down

0 comments on commit e9144df

Please sign in to comment.