portal

README

Portal to Astral

Portal is a runtime & development environment for multiplatform decentralized applications driven by Astral.

What is the Astral Network

Astral is an abstract network that provides authenticated and encrypted connections over a variety of physical networks. It provides simple and secure connectivity interface, which automatically adapts to existing network conditions. Its mission is to dramatically reduce the time it takes to build robust peer-to-peer networks.

What are the Astral Apps

Astral Apps are any applications capable to connect with Astral via Apphost Protocol.

Apphost Library is natively written in go, so you can import it into Golang project and write Astral App. While this approach can be useful for some cases, most likely may not be very convenient.

Why Portal

Portal is aimed to provide runtime environment for multiplatform Astral Apps and simplify the development process.

How to use

Depending on your case you may want to run the Astral App, develop the new one, or compile Portal Project. Read the following docs to learn more about possible use cases.

• User guide - How to install and use Portal Environment for users.
• Developer guide - How to create, develop, and build Astral Apps using Portal.
• Contributor guide - How to compile repository and general installer.
• Technical overview - Explains some technical details about the project.

Current Status

This project is at the alpha stage, which means is ready for testing and developing proof of concept apps but the SDK isn't complete and the API may change before the beta release.

Supported Platforms

List of platforms planned to include in support:

• Linux
  • Debian
  • Others - Not tested. Should work out of the box, but may require to install some dependencies manually. See tray and webview
• Windows
• Android - Outdated PoC, require adjustments
• macOS - require adjustments in installer
• iOS - TODO

Documentation

Index

• Constants

Constants

const (
	Version        = "v0.1.0"
	Name           = "Portal"
	NameDev        = "Portal Development"
	DescriptionDev = "Development environment for Astral apps."
	AstralVersion  = "v0.0.0-20240724222951-5cbd36ed486a"
	Module         = "github.com/cryptopunkscc/portal/"
)