Merge pull request #264 from UW-Macrostrat/refactor

Refactor test suite and clean up unused elements

Author: davenquinn

.yarn/releases/yarn-4.9.1.cjs .yarn/releases/yarn-4.11.0.cjs.yarn/releases/yarn-4.9.1.cjs renamed to .yarn/releases/yarn-4.11.0.cjs

@@ -1 +1 @@
-yarnPath: .yarn/releases/yarn-4.9.1.cjs
+yarnPath: .yarn/releases/yarn-4.11.0.cjs

.yarnrc.yml

@@ -17,15 +17,11 @@ Redis is optional. When the API starts requests for all columns and all units
 are cached. If Redis is available it will be used, otherwise they are cached in
 the application memory.
 
-The API requires `node` v14 or later to run. Recent testing has been conducted
-on `node` v18.
+The API requires `node` v20 or to run.
 
-#### Data
+## Data
 
-The following databases must be in place:
-
-- MariaDB - macrostrat
-- Postgres - burwell, alice, wof, elevation
+The `macrostrat` PostgreSQL database must be available.
 
 ## Setup
 
@@ -42,12 +38,6 @@ Next, install dependencies:
 yarn install
 ```
 
-NOTE: Postgres connections are completely broken in node v14 and v15 (as of
-2021-03-16). Use node v12!
-
-This will also run the script `postinstall.sh` which copies credentials files
-into place.
-
 ## Running the API
 
 Add environment variables to your shell or `.env` file. The
@@ -56,6 +46,17 @@ Add environment variables to your shell or `.env` file. The
 To start the API run `npm start <port|5000>`. This will start the API on the
 specified port (default 5000).
 
+## Running tests
+
+Tests can be run with `yarn test`. Currently, you must have a local instance of the
+API running separately (e.g., `yarn start` or `yarn run dev`). You can also set
+the `TEST_API_URL` variable to a different URL if you want to test a
+different instance.
+
+Additionally, you can set a `TEST_PRODUCTION_API_URL` to run comparisons against
+another running instance of the API (e.g., production). This is useful for
+ensuring that new versions of the API return the same results as older versions.
+
 ## Generating a release
 
 Update the version string in `package.json` and run:
@@ -74,6 +75,13 @@ instructions for generating a cache refresh key. The cache refresh key is used
 as a secret parameter to programmatically refresh the column cache, such as in
 situations in which the underlying data has been changed (editing, adding, etc).
 
+## Data
+
+Required databases (version 1):
+
+- MariaDB - macrostrat
+- Postgres - burwell, alice, wof, elevation
+
 ## Running
 
 To start the API simply run `npm start` which will start a process on port 5050.