2016-03-12 13:55:55 -05:00
# Tilde Friends
2021-01-03 15:10:29 -05:00
Tilde Friends is a program that aims to securely host and share pure JavaScript web applications.
2016-03-12 13:50:43 -05:00
## Goals
2021-01-02 13:10:00 -05:00
1. Make it easy and fun to run all sorts of web applications.
2016-03-12 13:50:43 -05:00
2. Provide a security model that is easy to understand and protects your data.
2021-01-03 15:10:29 -05:00
3. Make creating and sharing web applications accessible to anyone with a browser.
2016-03-12 13:50:43 -05:00
## Building
2021-01-02 13:10:00 -05:00
1. Requires libsodium and openssl. Other dependencies are kept up to date in the tree.
2021-01-03 15:10:29 -05:00
2. To build, run `make` or `make DEBUG=1` . An executable will be generated in a subdirectory of `out/` .
2020-09-22 21:58:13 -04:00
2016-03-12 13:50:43 -05:00
## Running
2021-01-03 15:10:29 -05:00
This is only just starting to show some signs of beginning to work as intended. Set expectations low.
Running the built `tildefriends` executable will start a web server at < http: // localhost:12345 /> . `tildefriends -h` lists further options.
2016-03-12 13:50:43 -05:00
2021-01-03 15:10:29 -05:00
The first user to create an account and log in will be granted administrative privileges. Everything can be managed entirely from the web interface.
2016-03-12 13:50:43 -05:00
2021-01-03 15:10:29 -05:00
Some starter apps can be installed by running `tildefriends import -u cory` . Hint: `~cory/docs/` and `~cory/index/` .
2017-01-08 11:25:07 -05:00
## Documentation
2021-01-03 15:10:29 -05:00
There are the very beginnings of developer documentation in `apps/cory/docs/` that can be read in-place or in-browser by running `tildefriends import -u cory` and then visiting < http: // localhost:12345 /~ cory / docs /> .
2017-01-08 11:25:07 -05:00
2016-03-12 13:50:43 -05:00
## License
2021-01-03 15:10:29 -05:00
All code unless otherwise noted in [COPYING ](https://www.unprompted.com/projects/browser/projects/tildefriends/trunk/COPYING ) is provided under the [Affero GPL 3.0 ](https://www.unprompted.com/projects/browser/projects/tildefriends/trunk/LICENSE ) license.
