Skip to content

Commit 9428317

Browse files
author
Florens Verschelde
committed
doc(support): Reorganize supported framework info
1 parent 3a97555 commit 9428317

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

Add_support_for_a_framework.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ WebContainers are designed to be secure by default and run within the browser's
6363

6464
# Upcoming Support
6565

66-
During the beta, compatibility efforts will be focused on Next.js development, with additional environments soon to come after. Check this repository regularly to see the latest updates and plans for WebContainer.
66+
During the beta, compatibility efforts will be focused on Next.js development, with additional environments soon to come. Check this repository regularly to see the latest updates and plans for WebContainer.
67+
68+
See [Supported Frameworks](Supported_frameworks.md) for details.
6769

6870
# FAQs
6971

Supported_frameworks.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
1-
## Supported frameworks
1+
# Supported frameworks
22

3-
The following is a list of frameworks that we have actively tested and are supported. Other frameworks may work OOTB. If not, feel free to open an issue on this repo.
3+
The following is a list of frameworks that we have actively tested and are supported. Other frameworks may work out of the box. If not, feel free to open an issue on this repo.
44

5-
PS: if you wanna add a framework to this list, feel free to help us out and follow the steps [here](Add_support_for_a_framework.md)!
5+
- [Next.js](https://stackblitz.com/fork/nextjs)
6+
- [NestJS](https://stackblitz.com/fork/nestjs-starter)
67

7-
1. [NextJS](https://stackblitz.com/fork/nextjs)
8-
2. [NestJS](https://stackblitz.com/fork/nestjs-starter)
8+
## Add support for a framework
99

10+
Since our technology allows you to run node programs in the secure context of your browser, it could be that the framework you want to use “just works”. If you want to try it out, follow these steps:
11+
12+
1. Go to <a href="https://stackblitz.com/fork/node" target="_blank">our node starter</a>
13+
2. Add a dependency to the framework you wanna try out by using `npm i ${framework}`
14+
3. Add the necessary files to the stackblitz example.
15+
4. See if it works!
16+
17+
If it works, great! Feel free to open a PR modifying this page, and give us the URL of your test project. We will verify if everything works after that.
18+
19+
If it doesn't work, you can file an issue by clicking the button in the editor or by creating an issue on this repo and we will try and figure out what went wrong.
20+
21+
In both cases: Thanks for helping us!

0 commit comments

Comments
 (0)