Skip to content

Commit

Permalink
docs(cu): update README
Browse files Browse the repository at this point in the history
  • Loading branch information
TillaTheHun0 committed Dec 20, 2023
1 parent 7baa7ef commit 40ab5f5
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions servers/cu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Server.

<!-- toc -->

- [Getting Started](#getting-started)
- [Usage](#usage)
- [Environment Variables](#environment-variables)
- [Running With CouchDB](#running-with-couchdb)
Expand All @@ -21,14 +20,13 @@ Server.

<!-- tocstop -->

## Getting Started

> For ease of development, this Compute Unit will use an embedded PouchDB, by default, when starting in development mode
## Usage

First install dependencies using `npm i`

> For ease of development, this Compute Unit can use an embedded PouchDB, great for local development. By default, when running via `npm run dev`,
> this is what is used
Then simply start the server using `npm start` or `npm run dev` if you are
working on the project locally. This will start a hot-reload process listening
on port `3005` by default.
Expand All @@ -50,13 +48,12 @@ There are a few environment variables that you can set:

### Running With CouchDB

This Compute Unit can be ran using a remote CouchDB. Simply set set `DB_MODE=remote` and `DB_URL` to the CouchDB connection string.
This Compute Unit can be ran using a remote CouchDB. Simply set set `DB_MODE=remote`
and `DB_URL` to the CouchDB connection string.

You will need a CouchDB database running. For convenience, a CouchDB
Of course, you will need a CouchDB database running. For convenience, a CouchDB
`Dockefile` and configuration is included in the `.couchdb` directory that you
can use to spin up a local Postgres instance

> The `.couchdb` directory is purely a convenience for local development
can use to spin up a CouchDB instance.

> If you use Gitpod, this is already done for you, as part of spinning up a new
> workspace
Expand Down

0 comments on commit 40ab5f5

Please sign in to comment.