Skip to content

Commit

Permalink
Merge pull request #411 from codeforpdx/update-readme-jsdoc
Browse files Browse the repository at this point in the history
Update JSdoc README
  • Loading branch information
leekahung authored Sep 13, 2023
2 parents a57bea9 + 230b9fa commit 50af696
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ To do so, you will need to edit the root `.env` file.
2. Start the SOLID server in a shell window

```shell
npm run dev:pod
npm run podserver
```

---
Expand All @@ -120,17 +120,15 @@ PASS is intended to work with any server that implements the SOLID protocol. How
You can change the port the server is listening on by using the `--port` or `-p` flags:

```shell
npm run dev:pod -- -p 1234
npm run podserver -- -p 1234
```
---

By default, community solid server stores all data in memory (i.e. it does not save data when it's shut down). To have it store data to your filesystem, you can use the command
Note: The `npm run podserver` command will launch a server that stores documents on your local file system. If you don't want to store documents, and want all server data to be deleted on shutdown, you can run

```shell
npm run dev:pod:stored
```

This will store all server files in the folder `PASS/local_temp_server_files`. This is a local testing directory, and the files within it should not be added to source control.
```shell
npm run podserver:temp
```

You can find more information on its configuration on the project's [github](https://github.com/CommunitySolidServer/CommunitySolidServer#configuring-the-server).

Expand Down

0 comments on commit 50af696

Please sign in to comment.