diff --git a/README.md b/README.md index 19bd472f..beaa67ff 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ -# Elk +

+ + Vite logo + +

+
+

+ discord chat + Start new PR in StackBlitz Codeflow +

+
-![Elk Logo](https://elk.zone/logo.svg) +# Elk A nimble Mastodon web client made with 🧡 @@ -10,7 +20,42 @@ Check out the [Open Issues](https://github.com/elk-zone/elk/issues) and jump in The client is deployed to [elk.zone](https://elk.zone), you can share screenshots on social media but avoid sharing this URL or the discord server until we open the repo. -If you would like to contribute, until the repo is open, please create branches in the main repository and send a PR from there. +> **Note** +> If you would like to contribute, until the repo is open, please create branches in the main repository and send a PR from there. + +# Contributing + +Hi! We're really excited that you're interested in contributing to Elk! Before submitting your contribution, please read through the following guide. + +## Online + +You can use [StackBlitz CodeFlow](https://stackblitz.com/codeflow) to fix bugs or implement features. You'll also see a CodeFlow button on PRs to review them without a local setup. + +[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https:///pr.new/___GH_ACCOUNT__/___GH_REPOSITORY___) + +## Local Setup + +Clone the repository and run on the root folder: + +``` +pnpm i +pnpm run dev +``` + +We recommend installing [ni](https://github.com/antfu/ni#ni), that will use the right package manager in each of your projects. If `ni` is installed, you can instead run: + +``` +ni +nr dev +``` + +## Testing + +Elk uses [Vitest](https://vitest.dev). You can run the test suite with: + +``` +nr test +``` # Stack