Skip to content

Commit

Permalink
Update READMEs for React, add React dev server port to devcontainer
Browse files Browse the repository at this point in the history
  • Loading branch information
alexsapps committed Jan 21, 2025
1 parent 6b59393 commit 3914a1a
Show file tree
Hide file tree
Showing 4 changed files with 2,413 additions and 1,889 deletions.
1 change: 1 addition & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@

// Use 'forwardPorts' to make a list of ports inside the container available locally.
"forwardPorts": [
3000, /* Frontend React dev server (adb.dxe.io/v2) */
8080, /* ADB main site (adb.dxe.io) */
8081 /* Members app (members.dxesf.org) */
]
Expand Down
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,20 @@ without a space.)

### Run

After downloading the dependencies, start the server:
After downloading the dependencies, start the development servers:

```bash
make run_all
```
Access the new frontend (React app) at http://localhost:3000/ - or test with
http://localhost:3000/v2/test

Access the web app at http://localhost:8080.
React pages auto-update in the frontend development server when you save
changes.

Access the Go API serverand and old frontend (Vue app) at http://localhost:8080

Access the Members app at members.dxesf.org at http://localhost:8081

### Code formatting

Expand All @@ -72,6 +79,11 @@ in serial.

### JS

The frontend is being migrated from Vue to React and is split into two
applications: the Vue app in /frontend and the React app in /frontend-v2.

#### Vue app

This project uses webpack to compile our frontend files. Frontend
files that need to be compiled are in `frontend/`, and the compiled
outputs are in `frontend/dist/`.
Expand All @@ -87,6 +99,12 @@ The most convenient workflow is to run `make watch` in one terminal
and `make run` in another one. Then your JS changes will automatically
be built as you edit them.

#### React app

See frontend-v2/README.md for more information on the React app. See above for
instructions on building and running the React app along with other components
of ADB.

## Required environment variables for running in prod:

- ADB_URL_PATH: For example, "http://adb.domain.com"
Expand Down
11 changes: 2 additions & 9 deletions frontend-v2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,8 @@ This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-

## Getting Started

First, run the development server:

```bash
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
See the main project README for initial, one-time setup as well as instructions
to build the project and run the development servers.

## Learn More

Expand Down
Loading

0 comments on commit 3914a1a

Please sign in to comment.