|
1 | | -# dweb-app - local dweb server for dweb Autonomi (REST API) |
| 1 | +# AutonomiDweb App |
2 | 2 |
|
3 | | -This is a simple app that gives access to the dweb on Autonomi. |
| 3 | +The AutonomiDweb App gives access to the dweb on Autonomi using a standard web browser. When running you can browse the dweb, and use dynamic web apps that upload files and save app data securely and privately on the Autonomi network. |
4 | 4 |
|
5 | | -It provides a local server so you can use a standard browser to view websites and use dynamic apps that load directly from the Autonomi secure peer-to-peer network. This is like IPFS and similar projects but websites and data will always be available without the need for pinning, seeding or ongoing payments. |
| 5 | +This is somewhat like IPFS and similar projects but on Autonomi data is secured forever. So websites and data will always be available without the need for pinning, seeding or ongoing payments, or the need for users of developers to maintain or pay for servers. |
6 | 6 |
|
7 | | -The Autonomi dweb is always there, providing secure access to your data which is always encrypted and can't be accessed, deleted or blocked by anyone else. |
8 | | - |
9 | | -## Status |
10 | | -This app was created using Tauri v2 and and SvelteKit and is in development. |
| 7 | +The AutonomiDweb is always there, providing secure access to your data which is always encrypted and can't be accessed, deleted or blocked by anyone else. |
11 | 8 |
|
12 | 9 | ### TODO: |
13 | | -- [ ] installation options and pre-requisites |
| 10 | +- [x] support browsing and use of dynamic websites |
| 11 | +- [ ] auto start on login |
| 12 | +- [ ] system tray support |
14 | 13 | - [ ] visit websites on Autonomi |
15 | | -- [ ] add screenshot |
16 | | -- [ ] link to other READMEs |
| 14 | +- [ ] add screenshot under "Browse the..." |
| 15 | + |
| 16 | +## Browse the Autonomi dweb |
17 | 17 |
|
18 | | -## Try the Autonomi dweb |
| 18 | +1. Visit the [releases page](https://github.com/happybeing/dweb/releases) and click on the link for your computer (Windows, Mac or Linux) |
19 | 19 |
|
20 | | -### Install dweb-app |
21 | | -TODO |
| 20 | +2. Save the executable (`dweb-app.exe` or `dweb-app`) on your computer. |
22 | 21 |
|
23 | | -## Web Publishers |
24 | | -Using the `dweb-cli` anyone can publish websites or dynamic web apps to Autonomi, accessible to anyone forever. |
| 22 | +3. Run the app as normal and click the "Browse" button to begin browsing websites on Autonomi. This will open your browser, and may show an error at first, but once it has connected to Autonomi will load a website showing links to some early websites and apps on Autonomi. |
25 | 23 |
|
26 | | -In fact, using dweb ensures that every version will remain accessible, so there's no more link rot or expired domains, and no more lost data. This also puts a stop to ransomware because all your data is versioned when uploaded with dweb. |
| 24 | +## Web Publishers and Web Developers |
| 25 | +If you wish to publish a website or a dynamic web app on Autonomi you will also need to download the dweb command line interface (dweb CLI). |
| 26 | + |
| 27 | +Using the `dweb-cli` anyone can publish websites or dynamic web apps to Autonomi, accessible to anyone forever. In fact, using dweb ensures that every version will remain accessible, so there's no more link rot or expired domains, and no more lost data. This also puts a stop to ransomware because all your data is versioned when uploaded with dweb. The CLI also includes other features useful to developers, such as inspecting data structures on the live network. |
27 | 28 |
|
28 | | -## Web Developers |
29 | 29 | Publishing websites or dynamic web apps using dweb is simple. Any static HTML website can be published and will be accessible in a standard browser just by the user running this `dweb-app`. |
30 | 30 |
|
31 | | -For web apps, you will be able to access the Autonomi API via the REST APIs provided by this `dweb-app`. |
| 31 | +Web apps are able to access the Autonomi API via the REST APIs of the AutonomiDweb App. |
32 | 32 |
|
33 | 33 | ## App Developers |
34 | | -Apps can integrate the dweb server directly using the `dweb-server` crate, avoiding the need for a user to run a separate server using this `dweb-app` or `dweb-cli`. Those crates are useful examples of how to do this. |
| 34 | +Native apps can integrate the dweb server directly using the `dweb-server` crate, avoiding the need for a user to run a separate server using the `dweb-app` or `dweb-cli`. Those crates are useful examples of how to do this. |
35 | 35 |
|
36 | 36 | ## dweb Autonomi REST API |
37 | 37 |
|
38 | 38 | For more about the REST API, and using `dweb-cli` to publish and view Autonomi websites and apps see: https://codeberg.org/happybeing/dweb/src/branch/main/dweb-cli#contents |
39 | 39 |
|
40 | 40 | # Development |
| 41 | +This app was created using Tauri v2 and selecting the SvelteKit front end with Javascript. |
41 | 42 |
|
42 | | -Install Tauri v2 and its pre-requisites for your system (see https://v2.tauri.app) |
| 43 | +For development, install Tauri v2 and its pre-requisites for your system (see https://v2.tauri.app) |
43 | 44 |
|
44 | 45 | ``` |
45 | | -git clone https://codeberg.org/happybeing/dweb-server-tauri-app |
46 | | -cd dweb-server-tauri-app |
| 46 | +git clone https://codeberg.org/happybeing/dweb |
| 47 | +cd dweb/dweb-app |
47 | 48 | cargo tauri dev |
48 | 49 | ``` |
49 | | -You can use this app to understand how to integrate a dweb REST server within your binary, or as a template for your own app. |
50 | | - |
51 | | -This app was created using Tauri v2 and selecting Rust GUI with Vanilla HTML, CSS and Javascript. |
52 | 50 |
|
53 | 51 | ## Recommended IDE Setup |
54 | 52 | HTML, |
|
0 commit comments