tooty/README.md

59 lines
1.6 KiB
Markdown
Raw Normal View History

2021-01-10 23:50:35 -05:00
# tooty fork
This is flewkey's personal fork of Tooty with various updates.
Send questions, issues, and patches to flewkey@2a03.party.
A public version is available at the following URL:
[https://files.2a03.party/~flewkey/tooty/](https://files.2a03.party/~flewkey/tooty/)
2021-11-30 23:11:39 -05:00
![](https://files.2a03.party/~flewkey/uploads/tooty-screenshot.png)
2017-04-15 03:18:02 -04:00
# tooty
2017-05-09 12:53:23 -04:00
An experimental multi-account [Mastodon Web client](https://n1k0.github.io/tooty/) written in Elm.
2017-05-26 03:38:58 -04:00
![](http://i.imgur.com/xxu6idX.png)
2017-05-09 12:53:23 -04:00
2017-05-09 12:55:43 -04:00
Tooty is a fully static Web application running in recent browsers, you don't need any custom server setup to use it. Just serve it and you're done, or use the [public version hosted on Github Pages](https://n1k0.github.io/tooty/).
2017-05-09 12:53:23 -04:00
If you want to self host Tooty, just [grab a build](https://github.com/n1k0/tooty/archive/gh-pages.zip) and serve it over HTTP.
### Setting up the development environment
$ npm i
$ ./node_modules/.bin/elm-package install
### Starting the dev server
$ npm start
### Starting the dev server in live debug mode
$ npm run debug
### Building
$ npm run build
2017-05-08 07:08:51 -04:00
### Optimizing
$ npm run optimize
This command compresses and optimizes the generated js bundle. It usually allows reducing its size by ~75%, at the cost of the JavaScript code being barely readable. Use this command for deploying tooty to production.
### Deploying to gh-pages
$ npm run deploy
2017-04-23 04:30:31 -04:00
The app should be deployed to https://[your-github-username].github.io/tooty/
2017-05-08 07:08:51 -04:00
Note: The `deploy` command uses the `optimize` one internally.
2017-04-26 03:03:54 -04:00
### Launching testsuite
2017-04-26 03:06:57 -04:00
$ npm test
2017-04-26 03:03:54 -04:00
## Licence
MIT