Skip to content
/ sable Public
forked from cinnyapp/cinny

Yet another matrix client but better

License

Notifications You must be signed in to change notification settings

7w1/sable

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,917 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Sable

A Matrix client built to enhance the user experience with quality-of-life features, cosmetics, utilites, and sheer usability. See the changelog.

Forked from Cinny.

Getting started

The web app is available at app.sable.moe and gets updated on frequently, as soon as a feature is deemed stable.

You can also download our desktop app for windows and linux from releases.

Self-hosting

To host Cinny on your own, download this repo and built with nginx.

npm ci # Installs all dependencies
npm run build # Compiles the app into the dist/ directory

After that, you can copy the dist/ directory to your server and serve it.

  • The default homeservers and explore pages are defined in config.json.

  • You can also disable the account switcher in the config.json.

  • To deploy on subdirectory, you need to rebuild the app youself after updating the base path in build.config.ts.

    • For example, if you want to deploy on https://sable.moe/app, then set base: '/app'.

Local development

Tip

We recommend using a version manager as versions change very quickly. You will likely need to switch between multiple Node.js versions based on the needs of different projects you're working on. NVM on windows on Windows and nvm on Linux/macOS are pretty good choices. Recommended nodejs version is Krypton LTS (v24.13.1).

Execute the following commands to start a development server:

npm ci # Installs all dependencies
npm start # Serve a development version

To build the app:

npm run build # Compiles the app into the dist/ directory

About

Yet another matrix client but better

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.6%
  • Other 1.4%