tildefriends/README.md

42 lines
1.2 KiB
Markdown
Raw Normal View History

# Tilde Friends
Tilde Friends is a program that aims to securely host and share pure JavaScript
web applications.
## Goals
1. Make it easy and fun to run all sorts of web applications.
2. Provide a security model that is easy to understand and protects your data.
3. Make creating and sharing web applications accessible to anyone from a web interface.
## Building
1. Requires libsodium and openssl. Other dependencies are kept up to date in the tree.
2. To build, run:
```
make
```
or
```
make DEBUG=1
```
Note for Raspberry Pi: http://www.mccarroll.net/blog/v8_pi2/index.html
## Running
Running the built tildefriends executable will start a web server. This is a
good starting point: <http://localhost:12345/>.
The first user to create an account and log in will be granted administrative
privileges. Everything can be managed entirely from the web interface.
This is all a work in progress.
## Documentation
## License
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.