Skip to content

Commit

Permalink
docs: update readmes:
Browse files Browse the repository at this point in the history
  • Loading branch information
ni-jessica committed Dec 4, 2023
1 parent 4ddcf1c commit cc7aa0a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ cmake --build .
Then, you can simply run

```console
./src/server
build/src/server <database filepath>
```

Ensure that the backend is running with the frontend, otherwise you will see a message of server errors on the front-end website.
15 changes: 9 additions & 6 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,16 @@ cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release
cmake --build .
```

From `/backend`, start the server with our precomputed database:
From `/backend`, start the server. Use the `--build` flag to create or rebuild a database for the breached passwords or omit it to use an existing one:

```bash
build/src/server build/passwords.db
build/src/server <database filepath> --build
```

or specify a new database path with the build flag:
```bash
build/src/server <path_to_database> --build
build/src/server build/passwords.db
```


To fix VS Code import errors with Crow, try adding the following line to your `settings.json`:

```json
Expand All @@ -42,5 +40,10 @@ To fix VS Code import errors with Crow, try adding the following line to your `s
After building, you can run tests from `/backend`:

```bash
cd build && ./tests
cd build && ./test/pdl_test
```

or alternatively:
```bash
make check
```

0 comments on commit cc7aa0a

Please sign in to comment.