How to Put (Almost) Anything in a Browser
Welcome to How to Put (Almost) Anything in a Browser at the MIT Media Lab's Festival of Learning (Spring 2023). This repository is a template you can use to get your own project started.
Tech Stack
The main technologies used in this repository are:
- React: A JavaScript-based library for building user interfaces.
- Next.js: A framework for building server-rendered React applications with automatic code splitting and optimized performance. We use this for added flexibility.
- Mantine: A UI framework for React that provides a set of high-quality and well-documented components for building web applications.
Getting Started
To get started with the repository using Github Codespaces, follow these steps:
- Create a Github account if you don't have one already.
- Click the
Use this template
button.
- Click
Create a new repository
, and fill in the information. You have to check the optionInclude all branches
.
- Go to
Settings
->Actions
->General
and change the following option:
- Once you have your repository, click the
Code
button and then click theCodespaces
tab.
- Click "Create codespaces on main" to launch the Codespaces environment.
- Wait for the environment to be fully set up (approx. 5 min). After a minute you should see this:
- Once the installation is done, you can launch the website locally.
npm run dev
- You should see a pop-up in the bottom right corner. Click "Open in Browser" to see our template.
Resources
The following resources may be helpful as you work through the code in this repository:
Contributing
If you find any issues or would like to contribute to the repository, please feel free to open a pull request or an issue. We welcome your feedback and contributions.
License
This repository is licensed under the MIT License.