README.md

MyFursona

The MyArtverse web and desktop client written in Next.js, Tailwind CSS, and Headless UI!

Overview

This repository is a monorepo containing frontend code written in TypeScript.

There are also codemods that are small and custom Node scripts to keep the codebase clean and maintainable.

Project structure

• apps
  • website: the Next.js frontend
  • desktop: desktop client written in Tauri
  • widget: used for embeds from other websites
• codemod: scripts to keep the codebase clean
• packages: shared configs and components

Contributing

Prerequisites

• Node.js (version 20 or higher)
• Yarn

Setup and Installation

Fork/clone the repository, install its dependencies and run the local dev server on the root directory:

git clone https://github.com/MyArtverse-Project/MyArtverse.git
cd MyArtverse
yarn
yarn dev

You can now access http://localhost:3000 on your browser!

Commands

• yarn dev - Serves a local web app
• yarn dev:w - Serves a widget app
• yarn build - Builds the web app
• yarn build:w - Builds the widget app

License

Apache 2.0