mirror of
https://github.com/modernweb-dev/rocket.git
synced 2026-03-10 08:51:24 +00:00
76 lines
3.2 KiB
Markdown
76 lines
3.2 KiB
Markdown
> This project is in its BETA phase
|
|
|
|
<p align="center">
|
|
<picture width="60%">
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/modernweb-dev/rocket/main/site/src/assets/rocket-logo-dark-with-text.svg">
|
|
<img alt="Rocket Logo" src="https://raw.githubusercontent.com/modernweb-dev/rocket/main/site/src/assets/rocket-logo-light-with-text.svg">
|
|
</picture>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/modernweb-dev/rocket/actions"
|
|
><img
|
|
src="https://img.shields.io/github/workflow/status/modernweb-dev/rocket/Release/main?label=workflow&style=flat-square"
|
|
alt="GitHub Actions workflow status"
|
|
/></a>
|
|
<a href="https://twitter.com/modern_web_dev"
|
|
><img
|
|
src="https://img.shields.io/badge/twitter-@modern_web_dev-1DA1F3?style=flat-square"
|
|
alt="Follow @modern_web_dev on Twitter"
|
|
/></a>
|
|
<a href="https://open.vscode.dev/modernweb-dev/rocket"
|
|
><img
|
|
src="https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc"
|
|
alt="Open in VS Code"
|
|
/></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://rocket.modern-web.dev">Website</a>
|
|
·
|
|
<a href="https://rocket.modern-web.dev/docs/">Documentation</a>
|
|
·
|
|
<a href="https://rocket.modern-web.dev/chat">Discord Community</a>
|
|
</p>
|
|
|
|
<h1></h1>
|
|
|
|
**The modern web setup for static sites with a sprinkle of JavaScript!**
|
|
|
|
- **Meta Framework:** Build on top of giants like <a href="https://lit.dev/">Lit</a>, <a href="https://rollupjs.org/">Rollup</a> and <a href="https://www.modern-web.dev/">Modern Web</a>.
|
|
- **Powerful Default Template:** Provide content and you are ready to go.
|
|
- **Small:** No overblown tools or frontend frameworks, add JavaScript and/or Web Components only on pages where needed..
|
|
|
|
<p align="center">
|
|
<a href="https://rocket.modern-web.dev/docs/setup/getting-started/"><strong>Getting Started With Rocket ▶</strong></a>
|
|
</p>
|
|
|
|
## The Goal for Rocket
|
|
|
|
> Our goal is to provide developers with a meta framework for static websites with a sprinkle of JavaScript.
|
|
|
|
Get a site up and running in no time and focus on the content.
|
|
You can still tweak every detail of every underlying tool that gets used.
|
|
|
|
Rocket is part of the [Modern Web Family](https://twitter.com/modern_web_dev).
|
|
|
|
<p align="center">
|
|
<a href="https://rocket.modern-web.dev/chat"><strong>Join our Discord Community ▶</strong></a>
|
|
</p>
|
|
|
|
## Quick Start
|
|
|
|
```
|
|
npx @rocket/create@latest
|
|
```
|
|
|
|
## 🤝 Contributing
|
|
|
|
We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/modernweb-dev/rocket/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
|
|
|
|
If you are interested in helping contribute to Modern Web, please take a look at our [Contributing Guide](https://github.com/modernweb-dev/rocket/blob/main/CONTRIBUTING.md). Also, feel free to drop into [discord](https://rocket.modern-web.dev/chat) and say hi. 👋
|
|
|
|
### Financial Contributors
|
|
|
|
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/modern-web/contribute)]
|