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: README.md
+18-8Lines changed: 18 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,25 @@
1
1
# Tidewave
2
2
3
-
> Tidewave Web for Next.js is currently in alpha testing!
3
+
> Tidewave Web for Next.js and React+Vite is currently in alpha testing!
4
4
5
5
Tidewave is the coding agent for full-stack web app development.
6
6
[See our website](https://tidewave.ai) for more information.
7
7
8
-
This package is recommended for JavaScript-powered backends as well as
9
-
JavaScript libraries/applications using a backend as a service (such as
10
-
Supabase). If you are using React with Phoenix, Rails, Django, or another
11
-
server-side framework, [follow the steps here instead](http://hexdocs.pm/tidewave/react.html).
8
+
If you are using Next.js or you have a React + Vite frontend, talking
9
+
either to a backend as a service (such as Supabase) or a third-party
10
+
framework, you are in the right place!
12
11
13
-
This project can also be used as a standalone Model Context Protocol (MCP)
14
-
server for your editors.
12
+
If you are using React with Django, FastAPI, Flask, Phoenix, or Rails,
13
+
[follow the steps here instead](http://hexdocs.pm/tidewave/react.html).
14
+
15
+
This project can also be used through the CLI or as a standalone Model
16
+
Context Protocol (MCP) server for your editors.
15
17
16
18
## Installation
17
19
18
20
### Next.js
19
21
20
-
Install it with:
22
+
If you are using Next.js, install Tidewave with:
21
23
22
24
```sh
23
25
$ npm install -D tidewave
@@ -110,8 +112,12 @@ export async function register() {
110
112
}
111
113
```
112
114
115
+
Now make sure [Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you are ready to connect Tidewave to your app.
116
+
113
117
### React + Vite
114
118
119
+
If you are building a front-end application, using a backend as a service, such as Supabase, or a non-officially supported web framework, we recommend using our React + Vite integration.
Now make sure [Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you are ready to connect Tidewave to your app.
145
+
146
+
If you are using Supabase or similar, you can prompt Tidewave to use the `supabase` CLI so it has complete access to your database. For non-officially supported web frameworks, our React + Vite integration allows Tidewave Web to perform changes on the front-end, and the agent will be able to modify your backend code as usual, but some functionality (such as accessing logs, doing database calls, etc) won't be available.
147
+
138
148
### Configuration
139
149
140
150
Next.js' `tidewaveHandler` and Vite's `tidewave` accept the configuration options below:
0 commit comments