Beam

A new way to experience the Internet.

Table of Contents

• 🚀 Getting Started
  • 🔧 Setup
  • 🩺 Tests
  • ⌨️ Development
  • 🌐 Web Components
• 👨‍💻 Contributors
• 📖 License

🚀 Getting Started

Important

The official development of beam macOS app has stopped in November 2022. Because the app is still used by some of us, and we still believe in a webkit-based ML-powered browser + note editor. We decided to open source it. This is still far from done, please reach out if you want to contribute [TBD]

Pull Requests with bug fixes and new features are much appreciated. We will be happy to review them and merge it once ready. If you have suggestions or want to report bugs please open an issue.

Our current focus is making the project build and run in debug mode, locally from Xcode.

🔧 Setup

Start by cloning the repo:

git clone [email protected]:beamlegacy/beam.git

Go inside the project inside the project:

cd beam

Run the setup script with:

make setup

🩺 Tests

TBD - Checkout README_previous.md to see old instructions.

⌨️ Development

TBD - The process

🌐 Web Components

Run yarn generate to use the CLI wizard to generate a preconfigured TS component. Then add the newly created message handler to the browsertab at BrowserTab.swift#83. Add simple example component to follow is the MediaPlayerMessageHandler.

👨‍💻 Contributors

TBD

📖 License

TBD