Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
brentvollebregt committed Dec 5, 2024
1 parent 8acde0f commit 37c2097
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

Currently, Node 17 and above is the only dependency.

1. Clone the repo.
1. Clone the repo
2. Setup the server
- Execute `npm install` to install dependencies
- Execute `cp .env.example .env` (or `copy` for Windows) and populate `.env`
Expand All @@ -44,9 +44,13 @@ Currently, Node 17 and above is the only dependency.

The client will use the `REACT_APP_API_ROOT` environment variable value to decide where to send requests. If this is not provided, the current hosted URL will be used.

The client can be started by executing `npm run start` in `./client`.

#### Server

`npm run dev` can be used for development of the server; this allows for hot-reloading. Running the client using `npm start` and setting `REACT_APP_API_ROOT` on the client to where the server is running will allow for a development setup with hot-reloading.
`npm run dev` in the root can be used for development of the server; this allows for hot-reloading.

Running the client using `npm start` in `./client` and setting `REACT_APP_API_ROOT` on the client to where the server is running will allow for a development setup with hot-reloading.

> The "Debug Server" launch configuration in vs code can be used to debug the server
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ app.use(lyricsSubRoute, LyricsRoutes);
const port = process.env.PORT || 5000;

if (!isProduction) {
// Even when running locally, we need to use HTTPS.Read the README for details.
// Even when running locally, we need to use HTTPS. Read the README for details.
https
.createServer(
{
Expand Down

0 comments on commit 37c2097

Please sign in to comment.