You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: hello-convex/README.md
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,23 @@
2
2
3
3
This is an example of using the Convex SDK to build a basic counter application.
4
4
5
-
The project is built with [React](https://reactjs.org/) and [TypeScript](https://www.typescriptlang.org/), bundled using [Vite](https://vitejs.dev/). It connects to a Convex server running at `localhost:8000` using the JavaScript SDK.
5
+
The project is built with [React](https://reactjs.org/) and
6
+
[TypeScript](https://www.typescriptlang.org/), bundled using
7
+
[Vite](https://vitejs.dev/). It connects to a Convex server running at the host
8
+
specified in `convex.json` using the JavaScript SDK.
6
9
7
10
## Running
8
11
9
-
First run `npm install` to pull in the required dependencies including the Convex SDK/CLI.
12
+
First run `npm install` to pull in the required dependencies including the
13
+
Convex SDK/CLI.
10
14
11
-
The application assumes you have the Convex HTTP server running at `http://localhost:8000`.
15
+
The application assumes you have the Convex HTTP server running at the given
16
+
host.
12
17
13
-
Before you can interact with the Convex server you need to first register your `/convex` functions with `npx convex register`. This command should be re-run any time these functions are changed.
18
+
Before you can interact with the Convex server you need to first register your
19
+
`/convex` functions with `npx convex register`. This command should be re-run
20
+
any time these functions are changed.
14
21
15
-
To run the app in development mode, use `npm run dev`. To build a production release, use `npm run build`. You can then view the static HTML using a simple web server with `npm run serve`.
22
+
To run the app in development mode, use `npm run dev`. To build a production
23
+
release, use `npm run build`. You can then view the static HTML using a simple
0 commit comments