tildefriends/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

66 lines
2.0 KiB
Markdown
Raw Normal View History

# Tilde Friends
2024-02-24 11:09:34 -05:00
Tilde Friends is a tool for making and sharing.
2024-02-18 21:31:07 -05:00
A public instance lives at https://www.tildefriends.net/.
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
2024-02-24 11:09:34 -05:00
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
2024-02-24 11:09:34 -05:00
Builds on Linux (x86_64 and aarch64), MacOS, OpenBSD, and Haiku. Builds for
2024-02-18 21:31:07 -05:00
all of those host platforms plus mingw64, iOS, and android.
Tilde Friends uses git submodules, so either:
```
git clone --recurse-submodules https://dev.tildefriends.net/cory/tildefriends.git
```
or:
```
git clone https://dev.tildefriends.net/cory/tildefriends.git
cd tildefriends
git submodule update --init --recursive
```
The `.tar.xz` source releases are all-inclusive.
1. On Linux only, system OpenSSL libraries (`libssl-dev`, in debian-speak) is
assumed to be available.
2024-02-24 11:09:34 -05:00
2. To build, run `make debug` or `make release`. An executable will be
generated in a subdirectory of `out/`.
3. It's possible to build for Android, iOS, and Windows on Linux, if you have
2024-02-24 11:09:34 -05:00
the right dependencies in the right places. `make windebug winrelease
iosdebug-ipa iosrelease-ipa release-apk`.
4. To build in docker, `docker build .`.
2024-02-18 21:31:07 -05:00
5. `make format` will normalize formatting to the coding standard.
## Running
2024-02-24 11:09:34 -05:00
By default, running the built `tildefriends` executable will start a web server
2024-02-24 11:09:34 -05:00
at <http://localhost:12345/>. `tildefriends -h` lists further options.
The first user to create an account and log in will be granted administrative
2024-02-24 11:09:34 -05:00
privileges. Further administration can be done at
<http://localhost:12345/~core/admin/>.
## Documentation
2024-02-24 11:09:34 -05:00
2024-02-18 21:31:07 -05:00
Docs are a work in progress:
<https://www.tildefriends.net/~cory/wiki/#test-wiki/tf-app-quick-reference>.
## License
2024-02-24 11:09:34 -05:00
All code unless otherwise noted in is provided under the
[MIT](https://opensource.org/licenses/MIT) license.