byCedric / bun-server-components-marz

πŸš€ A Fast and Lightweight React Server Components Framework for Bun

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Marz

πŸš€ A Fast and Lightweight React Server Components Framework for Bun

Bun Static Badge Discord Static Badge

Disclaimer

This project is still in very early development, and is currently meant to serve as a proof of concept. It is not recommended to use this in production.

Getting Started

Marz is built on top of Bun, so you'll need to install that first by following their installation guide.

Then clone this repo, and install its dependencies using bun install.

To run the server, use bun run index.tsx. This bundles all of your pages and components, and starts a server on port 3000. Currently there is no "watch" mode for development, so you'll need to restart the server manually after making changes.

Routing is determined by the file structure of your pages directory. For example, a file at pages/index.tsx will be served at /, and a file at pages/about.tsx will be served at /about. Each file is expected to export a named Page component. For now, all Page components must be server components, but they can import and use client components.

Contributing

Contributions are very welcome! This project is still in its early stages, so there are many ways to contribute. If you're interested in contributing, please join the Discord server and say hello πŸ‘‹

Authors

About

πŸš€ A Fast and Lightweight React Server Components Framework for Bun

License:MIT License


Languages

Language:TypeScript 100.0%