Skip to content

Update README.md #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 41 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,42 @@
# Revolt Website
<div align="center">
<h1>
Revolt Website

[![Stars](https://img.shields.io/github/stars/revoltchat/revolt.chat?style=flat-square&logoColor=white)](https://github.com/revoltchat/revolt.chat/stargazers)
[![Forks](https://img.shields.io/github/forks/revoltchat/revolt.chat?style=flat-square&logoColor=white)](https://github.com/revoltchat/revolt.chat/network/members)
[![Pull Requests](https://img.shields.io/github/issues-pr/revoltchat/revolt.chat?style=flat-square&logoColor=white)](https://github.com/revoltchat/revolt.chat/pulls)
[![Issues](https://img.shields.io/github/issues/revoltchat/revolt.chat?style=flat-square&logoColor=white)](https://github.com/revoltchat/revolt.chat/issues)
[![Contributors](https://img.shields.io/github/contributors/revoltchat/revolt.chat?style=flat-square&logoColor=white)](https://github.com/revoltchat/revolt.chat/graphs/contributors)
[![Licence](https://img.shields.io/github/license/revoltchat/revolt.chat?style=flat-square&logoColor=white)](https://github.com/revoltchat/revolt.chat/blob/main/LICENCE)
</h1>
Revolt marketing site built with Astro.
</div>
<br/>

Our marketing site. It's amazing. You should check it out. Just click [here](https://revolt.chat).
Website providing information regarding and downloads for the Revolt project that serves as a hub for everything Revolt related. You can view the site live at <https://revolt.chat>.

## Quick Start

Get the website up and running locally for development purposes. You'll need [Deno](https://deno.com).

> [!TIP]
> A [default.nix](https://github.com/revoltchat/revolt.chat/blob/main/default.nix) is available for Nix users! Just run `nix-shell` and continue.

```
git clone https://github.com/revoltchat/revolt.chat
cd revolt.chat
deno install --allow-scripts
deno task dev
```

You can now access the local site at <http://localhost:4321>.

## CLI Commands

| Command | Description |
| ------------------- | -------------------------------------- |
| `deno task dev` | Start the website in development mode. |
| `deno task start` | Alias of `deno task dev`. |
| `deno task build` | Builds the site ready for deployment. |
| `deno task preview` | Allows previewing the built site. |
| `deno task astro` | Returns Astro information. |