forked from cory/tildefriends
Compare commits
6 Commits
5551fd2dea
...
tasiaiso-s
| Author | SHA1 | Date | |
|---|---|---|---|
0b4ac2b355
|
|||
|
fae2771645
|
|||
|
2bb6d68122
|
|||
|
5c8c6e8760
|
|||
|
85ac8080f4
|
|||
|
0751699bc8
|
@ -1,4 +1,5 @@
|
||||
.svn
|
||||
db.sqlite
|
||||
db.*
|
||||
out/**/*.o
|
||||
out/**/*.d
|
||||
NOTES.md
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@ -8,3 +8,4 @@ out
|
||||
*.swo
|
||||
*.swp
|
||||
.zsign_cache/
|
||||
NOTES.md
|
||||
|
||||
@ -1,2 +1,5 @@
|
||||
default: true
|
||||
MD010: false # Ignore tabs in code blocks
|
||||
MD013: false # Don't wrap lines by default
|
||||
MD046:
|
||||
style: "fenced" # Force fenced code blocks
|
||||
|
||||
@ -15,3 +15,5 @@ apps/api/app.js
|
||||
|
||||
# only markdownlint should deal with the documentation
|
||||
docs/**/*.md
|
||||
|
||||
NOTES.md
|
||||
|
||||
@ -14,7 +14,7 @@ It is both a peer-to-peer social network client, participating in Secure Scuttle
|
||||
|
||||
## Documentation
|
||||
|
||||
Docs are a work in progress in the `docs` folder and in Tilde Friends: <https://www.tildefriends.net/~cory/wiki/#test-wiki/tf-app-quick-reference>.
|
||||
Docs are a work in progress in the `docs` folder, or alternatively in Tilde Friends: <https://www.tildefriends.net/~cory/wiki/#test-wiki/tf-app-quick-reference>.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@ -339,6 +339,13 @@ class TfElement extends LitElement {
|
||||
};
|
||||
|
||||
let tabs = html`
|
||||
<style>
|
||||
@media only screen and (max-width: 650px) {
|
||||
.hide-on-small-screens {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
<div class="w3-bar w3-theme-l1">
|
||||
${Object.entries(k_tabs).map(
|
||||
([k, v]) => html`
|
||||
@ -351,6 +358,7 @@ class TfElement extends LitElement {
|
||||
@click=${() => self.set_tab(v)}
|
||||
>
|
||||
${k}
|
||||
<span class="hide-on-small-screens">${v}</span>
|
||||
</button>
|
||||
`
|
||||
)}
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
# Philosophy
|
||||
# Tilde Friends
|
||||
|
||||
## Philosophy
|
||||
|
||||
Tilde Friends is a platform for making, running, and sharing web applications.
|
||||
|
||||
@ -135,16 +137,18 @@ Sets the browser window/tab title.
|
||||
|
||||
Reconfigures the terminal layout, potentially into multiple split panes.
|
||||
|
||||
terminal.split([
|
||||
{
|
||||
type: "horizontal",
|
||||
children: [
|
||||
{name: "left", basis: "2in", grow: 0, shrink: 0},
|
||||
{name: "middle", grow: 1},
|
||||
{name: "right", basis: "2in", grow: 0, shrink: 0},
|
||||
],
|
||||
},
|
||||
]);
|
||||
```javascript
|
||||
terminal.split(
|
||||
[{
|
||||
type: "horizontal",
|
||||
children: [
|
||||
{name: "left", basis: "2in", grow: 0, shrink: 0},
|
||||
{name: "middle", grow: 1},
|
||||
{name: "right", basis: "2in", grow: 0, shrink: 0},
|
||||
],
|
||||
}]
|
||||
);
|
||||
```
|
||||
|
||||
#### terminal.select(name)
|
||||
|
||||
50
docs/apps/quickstart.md
Normal file
50
docs/apps/quickstart.md
Normal file
@ -0,0 +1,50 @@
|
||||
# Writing Tilde Friends applications7
|
||||
|
||||
TODO
|
||||
|
||||
## Creating your environment
|
||||
|
||||
1. Open an existing application (ie: `identity`);
|
||||
2. Open the editing panel;
|
||||
3. Save the app under a new name (ie `/~YOUR_USERNAME/my-app/`);
|
||||
4. Go back to the main menu and open your new app;
|
||||
5. You can now edit your app, save it and see changes in the real time.
|
||||
|
||||
## Project structure
|
||||
|
||||
An application has a `app.js` file that gets run when a user enters the app.
|
||||
This file contains a function (typically called `main()`) that's considered the entry point.
|
||||
|
||||
Paste this in `app.js`:
|
||||
|
||||
```javascript
|
||||
async function main() {
|
||||
let ids = await ssb.getIdentities();
|
||||
await app.setDocument(`
|
||||
<body style="font-family: sans-serif; color: white">
|
||||
<h1>Hello world!</h1>
|
||||
</body>
|
||||
</body>`);
|
||||
}
|
||||
|
||||
main();
|
||||
```
|
||||
|
||||
Save the app, and you should now be seeing `Hello world!` on the screen.
|
||||
|
||||
|
||||
## Components
|
||||
|
||||
Once your app grows to a certain size, you'll want to introduce components.
|
||||
In Tilde Friends, the de facto standard is [Lit](TODO).
|
||||
Althogh you an use any framework you want, you're encouraged to use Lit as you can reuse
|
||||
|
||||
First, add lit-all-min.js into your project.
|
||||
|
||||
TODO
|
||||
|
||||
<!-- mention shadow dom -->
|
||||
|
||||
TODO: tfrpc
|
||||
|
||||
TODO: sharing apps
|
||||
@ -28,7 +28,7 @@ Dependencies for Windows:
|
||||
|
||||
2. Run `make -j $(nproc) debug` or `make -j $(nproc) release`
|
||||
|
||||
> If you're unsure whether you should choose `debug` or `release`, stick to `release`.
|
||||
If you're unsure whether you should choose `debug` or `release`, stick to `release`.
|
||||
|
||||
> `-j $(nproc)` will start a compiler for every CPU thread, which will dramatically reduce the time needed to compile Tilde Friends.
|
||||
|
||||
@ -38,21 +38,22 @@ It's possible to build for Android, iOS, and Windows on Linux, if you have the r
|
||||
|
||||
To build in docker, `docker build .`
|
||||
|
||||
On NixOS: TODO
|
||||
<!-- On NixOS: TODO -->
|
||||
<!-- Add shell.nix and nix derivs first -->
|
||||
|
||||
Now that you have a binary, head over to <running.md>.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### The compiler throws an error and I can't build the binary.
|
||||
### The compiler throws an error and I can't build the binary
|
||||
|
||||
Open `GNUMakefile` and edit the CFLAGS environment variable around line 50.
|
||||
|
||||
For example given this error:
|
||||
|
||||
```
|
||||
src/http.c: In function ‘tf_http_get_cookie’:
|
||||
src/http.c:1089:128: error: check of ‘name’ for NULL after already dereferencing it [-Werror=analyzer-deref-before-check]
|
||||
```text
|
||||
src/http.c: In function 'tf_http_get_cookie':
|
||||
src/http.c:1089:128: error: check of 'name' for NULL after already dereferencing it [-Werror=analyzer-deref-before-check]
|
||||
```
|
||||
|
||||
Add:
|
||||
|
||||
@ -10,14 +10,23 @@ Alternatively, you can change the `origin` remote on your existing clone:
|
||||
|
||||
- Make your changes
|
||||
|
||||
- I want to edit C code !
|
||||
- I want to edit C code !
|
||||
|
||||
- I want to edit JavaScript code !
|
||||
TODO
|
||||
|
||||
- I want to write documentation !
|
||||
- I want to edit JavaScript code !
|
||||
|
||||
TODO
|
||||
|
||||
- I want to write documentation !
|
||||
|
||||
Great! Before you do, have a look at the [documentation guidelines](guidelines/documentation-guidelines.md) to learn how to write consistent documentation.
|
||||
|
||||
In all cases:
|
||||
|
||||
- Make sure that your commit messages are descriptive.
|
||||
<!-- - hi -->
|
||||
|
||||
- Format your changes:
|
||||
|
||||
If you've edited C code: run `make format`
|
||||
|
||||
@ -14,4 +14,6 @@ See <faq.md>.
|
||||
|
||||
## Guide
|
||||
|
||||
See <guide.md>.
|
||||
This document will be phased out and integrated into the new documentation.
|
||||
|
||||
See <.guide.md>.
|
||||
|
||||
@ -4,6 +4,6 @@
|
||||
|
||||
See <running.md>.
|
||||
|
||||
### The compiler throws an error and I can't build the binary.
|
||||
### The compiler throws an error and I can't build the binary
|
||||
|
||||
See <building.md>.
|
||||
|
||||
1
docs/guidelines/c-guidelines.md
Normal file
1
docs/guidelines/c-guidelines.md
Normal file
@ -0,0 +1 @@
|
||||
TODO
|
||||
@ -16,7 +16,8 @@ Their names should be meaningful and SHOULD not conflict with other files in oth
|
||||
|
||||
## Documentation
|
||||
|
||||
When writing documentation, the author should have in mind it's target audience: people with varying technical skills and backgrounds, fluency in peer-to-peer-specific terms and mental ability. The documentation should therefore be acessible and usefule to most people interested in building, using and contributing to Tilde Friends.
|
||||
When writing documentation, the author should have in mind it's target audience: people with varying technical skills and backgrounds, fluency in peer-to-peer-specific terms and mental ability.
|
||||
The documentation should therefore be acessible and usefule to most people interested in building, using and contributing to Tilde Friends.
|
||||
|
||||
### Terminology
|
||||
|
||||
@ -26,7 +27,37 @@ When writing documentation, the author should have in mind it's target audience:
|
||||
|
||||
### Style guide
|
||||
|
||||
TODO
|
||||
1. Lines SHOULD NOT be wrapped, to allow clients to dynamically wrap them however they want:
|
||||
|
||||
```text
|
||||
This is not very pleasant to read because
|
||||
the text
|
||||
is manually wrapped, but the size of the
|
||||
screen is
|
||||
smaller than the size the text is wrapped
|
||||
at. I
|
||||
need to write even more useless text here
|
||||
so I get
|
||||
my point across. Also hi! If you're here
|
||||
that
|
||||
means you're either going to contribute to
|
||||
Tilde
|
||||
Friends, or that you're reviewing my
|
||||
stupid
|
||||
changes. Either way, you're awesome!
|
||||
```
|
||||
|
||||
You MAY use one line per sentence.
|
||||
|
||||
2. Lines ending with an `inline code block` SHOULD NOT end with a period.
|
||||
|
||||
> Example: To build in docker, `docker build .`
|
||||
|
||||
NB: this does not apply to file names or other text that are not meant to be copy-pasted.
|
||||
|
||||
> Example: this document is named `docs/guidelines/documentation-guidelines.md` instead of `docs/guidelines/documentation.md` because it could cause confusion with `docs/documentation.md`.
|
||||
|
||||
More TODO
|
||||
|
||||
## License
|
||||
|
||||
|
||||
1
docs/guidelines/javascript-guidelines.md
Normal file
1
docs/guidelines/javascript-guidelines.md
Normal file
@ -0,0 +1 @@
|
||||
TODO
|
||||
@ -6,15 +6,45 @@ The binaries should appear at `out/debug/tildefriends` and `out/release/tildefri
|
||||
|
||||
For Android, iOS and Windows: TODO
|
||||
|
||||
You can start the server by running `./out/debug/tildefriends` or `./out/release/tildefriends`.
|
||||
You can now start the server by running `./out/debug/tildefriends` or `./out/release/tildefriends`.
|
||||
|
||||
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/>.
|
||||
|
||||
## How to use TF
|
||||
|
||||
TODO
|
||||
### Initial setup
|
||||
|
||||
Now you have a Tilde Friends instance running. The first thing you'll want to do is create your account. Click "login" in the top right corner, then "Register".
|
||||
Enter your username and password.
|
||||
|
||||
> 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/>
|
||||
|
||||
Next, create a Scuttlebutt identity by pressing the "Create an identity" button.
|
||||
This will create a pair of keys that are used to sign your messages with.
|
||||
|
||||
Because of the way Scuttlebutt is designed, you cannot log into your account without your keys.
|
||||
Tilde Friends locks your keys behind a password, but if you were to destroy your database, the keys would be gone forever, and with it your possibility to send messages using this account. Click on the `identity` app and under "Identities", export your newly created identity.
|
||||
|
||||
You'll be prompted with a dialog box saying "This app is requesting the following permission:ssb_id_export".
|
||||
This is because applications are not trusted to have access to your keys by default.
|
||||
Click on "Allow" and you'll see a list of 12 words. You need to write those down in a password manager or on a piece of paperand keep it private and secure.
|
||||
|
||||
> Warning: Nobody needs to know these 12 words. Anybody that has access to those keys can post messages as you, see your private messages and documents and much more.
|
||||
|
||||
Now that your keys are safe, we can start connecting to the outside world.
|
||||
|
||||
### Replication
|
||||
|
||||
You've probably noticed asdtring of random characters by now. This is your public key, a unique identifier for your account you can share to anyone. If you go back to the home menu and into the `ssb` app, you can click on your public key. This will lead you to your profile, which is empty at the time. Edit it and enter your name.
|
||||
|
||||
TODO: joining a room
|
||||
|
||||
TODO: initial sync
|
||||
|
||||
TODO: send messages
|
||||
|
||||
TODO: how messages spread to friends
|
||||
|
||||
TODO: other apps
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"scripts": {
|
||||
"format": "npm run prettier && npm run markdown",
|
||||
"prettier": "npx prettier --cache --write --check .",
|
||||
"markdown": "npx markdownlint-cli 'docs/**/*.md' -f"
|
||||
"markdown": "npx markdownlint-cli --fix 'docs/**/*.md'"
|
||||
},
|
||||
"author": "Cory McWilliams",
|
||||
"license": "MIT",
|
||||
|
||||
Reference in New Issue
Block a user