Skip to content
 
 

Latest commit

 

History

1,598 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stoat Frontend

Stars Forks Pull Requests Issues Contributors License

<<<<<<< HEAD The official web client powering https://beta.revolt.chat/app, built with Solid.js 💖.
Track the project roadmap on OpenProject. ======= The official web client powering https://stoat.chat/app, built with Solid.js 💖.
Track the project roadmap on OpenProject. >>>>>>> addb6b7c84bf3852691f3311470e714bbe9b5522

Development Guide

<<<<<<< HEAD Before contributing, make yourself familiar with our contribution guidelines, the code style guidelines, and the technical documentation for this project.

Before getting started, you'll want to install:

Before getting started, you'll want to install:

addb6b7c84bf3852691f3311470e714bbe9b5522

Then proceed to setup:

# clone the repository
git clone --recursive https://github.com/stoatchat/for-web client
cd client

# update submodules if you pull new changes
# git submodule init && git submodule update

# install all packages
<<<<<<< HEAD
pnpm i --frozen-lockfile

# build deps:
pnpm build:deps
=======
mise install:frozen

# build deps:
mise build:deps
>>>>>>> addb6b7c84bf3852691f3311470e714bbe9b5522

# or build a specific dep (e.g. stoat.js updates):
# pnpm --filter stoat.js run build

# customise the .env
cp packages/client/.env.example packages/client/.env

# run dev server
<<<<<<< HEAD
pnpm dev:web
=======
mise dev

# run all CI checks locally
mise check
>>>>>>> addb6b7c84bf3852691f3311470e714bbe9b5522

Finally, navigate to http://local.revolt.chat:5173.

Pulling in Stoat's brand assets

If you want to pull in Stoat brand assets after pulling, run the following:

# update the assets
git -c submodule."packages/client/assets".update=checkout submodule update --init packages/client/assets

You can switch back to the fallback assets by running deinit and continuing as normal:

# deinit submodule which clears directory
git submodule deinit packages/client/assets

Deployment Guide

Build the app

# install packages
<<<<<<< HEAD
pnpm i --frozen-lockfile

# build dependencies
pnpm build:deps

# build for web
pnpm build:web

# ... when building for Stoat production, use this instead of :web
pnpm build:prod
=======
mise install:frozen

# build dependencies
mise build:deps

# build for web
mise build

# ... when building for Stoat production
mise build:prod
>>>>>>> addb6b7c84bf3852691f3311470e714bbe9b5522

You can now deploy the directory packages/client/dist.

Routing Information

The app currently needs the following routes:

  • /login
  • /pwa
  • /dev
  • /discover
  • /settings
  • /invite
  • /bot
  • /friends
  • /server
  • /channel

<<<<<<< HEAD This corresponds to Content.tsx#L33.

This corresponds to Content.tsx#L33.

addb6b7c84bf3852691f3311470e714bbe9b5522

About

Stoat for Web – browser app for Stoat

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages