Merge pull request #6 from ArroyoSystems/setup_fixes

Improvements to dev setup instructions

README.md

@@ -1,34 +1,18 @@
-# Mintlify Starter Kit
+# Arroyo Docs
 
-Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
+This repo contains the source code to documentation website (https://doc.arroyo.dev) for [Arroyo](https://arroyo.dev).
 
-- Guide pages
-- Navigation
-- Customizations
-- API Reference pages
-- Use of popular components
+## Doc development
 
-### 👩‍💻 Development
+We use [mintlify](https://mintlify.com) for our docs. The live website is automatically rebuilt on every merge to this
+repo. To develop docs locally, you can install the mintlify dev CLI:
 
-Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
-
-```
-npm i -g mintlify
+```bash
+$ npm i -g mintlify
 ```
 
-Run the following command at the root of your documentation (where mint.json is)
+Then changes can be previewed by running this command in the root of the repository:
 
+```bash
+$ mintlify dev
 ```
-mintlify dev
-```
-
-### 😎 Publishing Changes
-
-Changes will be deployed to production automatically after pushing to the default branch.
-
-You can also preview changes using PRs, which generates a preview link of the docs.
-
-#### Troubleshooting
-
-- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
-- Page loads as a 404 - Make sure you are running in a folder with `mint.json`

developing/dev-setup.mdx

@@ -32,6 +32,7 @@ can be changed by setting the following environment variables:
 
 * `DATABASE_NAME`
 * `DATABASE_HOST`
+* `DATABSE_PORT`
 * `DATABASE_USER`
 * `DATABASE_PASSWORD`
 
@@ -65,15 +66,16 @@ $ cargo build --release
 
 ## Building the frontend
 
-We use pnpm and vite for frotend development.
+We use pnpm and vite for frontend development.
 
 Start by installing pnpm by following the instructions here: https://pnpm.io/installation.
 
 Then you should be able to run the console in dev mode like this:
 
 ```
 $ cd arroyo-console
-$ pnpm build
+$ pnpm install
+$ pnpm dev
 ```
 
 This will launch a dev server at http://localhost:5173 (note the api must
@@ -85,3 +87,29 @@ can run
 ```
 $ pnpm build
 ```
+
+## Running the services
+
+Arroyo requires running at least two services: arroyo-api and arroyo-controller. See [here](/architecture) for an
+overview of the services and what they do.
+
+The services can be run with cargo:
+
+```bash
+$ cargo run --bin arroyo-controller
+# in a separate terminal
+$ cargo run --bin arroyo-api
+```
+
+To get faster compilation of pipelines, you can also run the compile service:
+
+```bash
+$ cargo run --bin arroyo-compiler-service
+```
+
+then set the `REMOTE_COMPILER_ENDPOINT` environment variable when running the controller like this:
+
+```bash
+$ REMOTE_COMPILER_ENDPOINT=http://localhost:9000 cargo run --bin arroyo-controller
+```
+