Awesome

<p align="center"> <a href="https://elk.bumscode.com" target="_blank" rel="noopener noreferrer"> <img height="160" src="./public/crab-original.png" alt="crab logo"> </a> </p> <h1 align="center"/>crab <sup><em>alpha</em></sup></h1>

A nimble Mastodon web client, based on elk and customized for bumscode.com.

⚠️ Crab and its parent Elk are in Alpha

If you want to contribute to the parent project, check out its repo.

Deployment

Official Deployment

The crab team maintains a deployment at:

🦀 Production: crab.bumscode.com

💖 Sponsors

If you're enjoying the app, consider sponsoring the Elk team:

Elk Team's GitHub Sponsors

Or you can sponsor their core team members individually:

We would also appreciate sponsoring other contributors to the Elk project. If someone helps you solve an issue or implement a feature you wanted, supporting them would help make this project and OS more sustainable.

🚀 Contributing

Feel free to open PRs on this repo if you want to contribute to crab! If you want to contribute to Elk, check out their Contributing Guide.

Local Setup

Clone the repository and run on the root folder:

pnpm i
pnpm run dev

Warning: you will need corepack enabled, check out the Elk Contributing Guide for a detailed guide on how to set up the project locally.

We recommend installing 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. You can run the test suite with:

nr test

📲 PWA

You can consult the PWA documentation to learn more about the PWA capabilities on Elk, how to install Elk PWA in your desktop or mobile device and some hints about PWA stuff on Elk.

🦄 Stack

Vite - Next Generation Frontend Tooling
Nuxt - The Intuitive Web Framework
Vue - The Progressive JavaScript Framework
VueUse - Collection of Vue Composition Utilities
Pinia - The Vue Store that you will enjoy using
Vue Macros - More macros and syntax sugar for Vue
UnoCSS - The instant on-demand atomic CSS engine
Iconify - Iconify icon sets in JSON format
Masto.js - Mastodon API client in TypeScript
shiki - A beautiful yet powerful syntax highlighter
vite-plugin-pwa - Prompt for update, Web Push Notifications and Web Share Target API

👨‍💻 Contributors