Cory McWilliams
28d73f5b37
git-svn-id: https://www.unprompted.com/svn/projects/tildefriends/trunk@4199 ed5197a5-7fde-0310-b194-c3ffbd925b24
37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
# Tilde Friends
|
|
Tilde Friends is a tool for making and sharing.
|
|
|
|
It is both a peer-to-peer social network client, participating in Secure
|
|
Scuttlebutt, as well as a platform for writing and running web applications.
|
|
|
|
## Goals
|
|
1. Make it easy and fun to run all sorts of web applications.
|
|
2. Provide security that is easy to understand and protects your data.
|
|
3. Make creating and sharing web applications accessible to anyone with a
|
|
browser.
|
|
|
|
## Building
|
|
1. Requires openssl (`libssl-dev`, in debian-speak). All other dependencies
|
|
are kept up to date in the tree.
|
|
2. To build, run `make debug` or `make release`. An executable will be
|
|
generated in a subdirectory of `out/`.
|
|
3. `make windebug` or `make winrelease` will generate a windows executable
|
|
which might work.
|
|
4. To build in docker, `docker build .`.
|
|
|
|
## Running
|
|
By default, running the built `tildefriends` executable will start a web server
|
|
at <http://localhost:12345/>. `tildefriends -h` lists further options.
|
|
|
|
The first user to create an account and log in will be granted administrative
|
|
privileges. Further administration can be done at
|
|
<http://localhost:12345/~core/admin/`>.
|
|
|
|
## Documentation
|
|
There are the very beginnings of developer documentation in `apps/docs/`
|
|
that can be read in-place or at <http://localhost:12345/~core/docs/>.
|
|
|
|
## License
|
|
All code unless otherwise noted in is provided under the
|
|
[MIT](https://opensource.org/licenses/MIT) license.
|