Update readme with archive headsup

Author: planteater

Diff for: README.md

@@ -1,107 +1 @@
-# CodeStream Backend Services
-
-On the backend (aka. the server-side), CodeStream runs a number of services to
-provide all the functionality needed for the clients. The default development
-environment will use the codestream broadcaster with outbound mail
-disabled.
-
-## Development Setup with docker-compose
-
-### Prerequisites
-
-1. Mac or Linux computer using zsh or bash.
-
-1. [Docker Desktop](https://www.docker.com/products/docker-desktop) which we'll
-   use to provide MongoDB.
-
-1. Make sure you are authenticated with vault!, i.e.
-
-  `newrelic-vault us login -method=okta username=<username> totp=<otp>`
-
-1. If you plan to enable outbound email, make sure you have a working
-   AWS session to the CodeStream development account. If this requires
-   use of the `AWS_*` environment variables and you plan to launch from
-   the debugger, ensure they're defined in the appropriate block in
-   `.vscode/launch.json`.
-
-### Installation
-
-For local development we use docker compose to only run mongodb. You will need to run the 
-api-server locally via your IDE or command line.
-
-1. Clone and setup
-   [faker-service-gateway](https://source.datanerd.us/codestream/faker-service-gateway).
-   Faker service gateway will handle SSL and proxy requests to the api-server.
-
-1. Clone the [codestream-server](https://github.com/teamcodestream/codestream-server) repo.
-
-1. Start up the docker container for MongoDB via docker compose.
-   ```
-   docker compose up mongodb -d
-   ```
-1. Install dependencies
-   ```
-   npm run install:all
-   ```
-
-### Mongo upgrade caveat
-
-If you have been running mongodb 4 in docker compose you will need to delete the mongodb volume to get a clean start 
-for mongodb 5, otherwise mongo will exit shortly after startup. This will delete all the data in your local docker
-mongodb instance. 
-
-```
-docker compose down --volumes
-docker compose up mongodb -d
-```
-
-With a fresh database you will need to run `./start-api-server.sh -init-db-only` before being able to run api-server from the IDE. 
-
-
-### Method 1 - launch from shell and run natively
-
-1. Setup and start up the api-server without docker. The default
-   behavior is to initialize the database and disable outbound
-   email queueing.
-   ```
-   ./start-api-server.sh [-init-db-only | -no-db | -enable-mailout | -mock-mode ]
-   ```
-
-### Method 2 - launch from IDE
-
-1. Review the pre-reqs above to ensure you set any additional vars
-   needed for your use case.  `.vscode/launch.json` has some comments
-   to help.
-
-1. Select any of the the `api_srv.js` run configurations from vscode or
-   jetbrains.
-
-Point your CodeStream extension to https://localhost.newrelic.com:12079. You
-should be able to login and see o11y.
-
-Develop to your heart's content!!!!  We _love_ pull-requests.
-
-## Run everything in docker
-
-Not working right now :(. Check back later.
-
-## Running Tests
-
-As usual, make sure you are authenticated with vault. 
-
-Start the api server - use `-mock-mode` flag if needed
-```bash
-./start-api-server.sh [-init-db-only | -no-db | -enable-mailout | -mock-mode ]
-```
-
-In a separate terminal, source testMode.sh (this will also set CS_API_MOCK_MODE=1)
-
-```bash
-. ./testMode.sh
-```
-
-then run the tests
-```bash
-cd api_server
-npm run test
-```
+NOTE: This code will be archived by the end of July 2024.