CloudToys/elk
1
0
Fork 0
Code

chore: adding open in codeflow to readme (#205)

Browse Source 
Co-authored-by: patak <matias.capeletto@gmail.com>
This commit is contained in:
Garrison Snelling 2022-11-28 10:55:34 -06:00 committed by GitHub
parent ed0b78857c
commit dab5aace31
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -1,6 +1,16 @@
# Elk <p align="center">
<a href="https://viteconf.org" target="_blank" rel="noopener noreferrer">
<img width="180" src="https://elk.zone/logo.svg" alt="Vite logo">
</a>
</p>
<br/>
<p align="center">
<a href="https://chat.elk.zone"><img src="https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord" alt="discord chat"></a>
<a href="https:///pr.new/___GH_ACCOUNT__/___GH_REPOSITORY___"><img src="https://developer.stackblitz.com/img/start_pr_dark_small.svg" alt="Start new PR in StackBlitz Codeflow"></a>
</p>
<br/>
![Elk Logo](https://elk.zone/logo.svg) # Elk
A nimble Mastodon web client made with 🧡 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. 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 # Stack