Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mattsrobot committed Mar 8, 2024
1 parent 922acfa commit 89e4ebc
Showing 1 changed file with 7 additions and 14 deletions.
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,23 @@ Create a .env file in the project root with the following:

```
X_WICKED_HEADER='something'
API_URL='http://localhost:3003/v1'
HOT_URL='http://localhost:3005/v1'
WEB_URL='http://localhost:3000'
WRITE_HOT_URL='http://localhost:3005/v1'
READ_HOT_URL='http://localhost:3005/v1'
WS_URL='ws://localhost:3006/ws'
ELECTRON="false"
```

X_WICKED_HEADER is a header used to identify clients connecting to the API. For running locally you can use any value, but for connecting to the production environment - Cloudflare will block requests without a valid header.

API_URL is the Auth server (usually port 3003 locally).
You'll need to build and run the Go backend to make API requests (HOT_URL and WS_URL is the backend API).

HOT_URL is the Hot server (usually port 3005 locally).
X_WICKED_HEADER is a header used to identify clients connecting to the API. For running locally you can use any value, but for connecting to the production environment - Cloudflare will block requests without a valid header.

# Running the app locally

```npx remix dev```

You should see a Remix server running locally on port 3000

# Creating a new user

In order to create an account you'll need to create a new record in the beta_users table (assuming you have a MySQL server running and have run go migrate to setup the tables).

Create a new entry in beta_users with your email address, with redeemed set to 0, and enabled set to 1.

Now you can navigate your browser to http://localhost:3000/signup and create your user.

# Building web app app:

```
Expand Down

0 comments on commit 89e4ebc

Please sign in to comment.