https://github.com/airmessage/airmessage-web

AirMessage for the web
https://github.com/airmessage/airmessage-web

imessage web

Last synced: about 2 months ago
JSON representation

AirMessage for the web

• Host: GitHub
• URL: https://github.com/airmessage/airmessage-web
• Owner: airmessage
• License: apache-2.0
• Created: 2021-01-02T17:09:14.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-12-24T23:12:35.000Z (over 1 year ago)
• Last Synced: 2024-06-03T00:35:10.446Z (4 months ago)
• Topics: imessage, web
• Language: TypeScript
• Homepage: https://web.airmessage.org
• Size: 6.43 MB
• Stars: 154
• Watchers: 5
• Forks: 12
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AirMessage for web

![AirMessage running on Microsoft Edge](README/windows-web.png)

AirMessage lets people use iMessage on the devices they like.

**AirMessage for web** brings iMessage to modern web browsers over a WebSocket proxy.

Production builds are hosted on [web.airmessage.org](https://web.airmessage.org).

Other AirMessage repositories:

[Server](https://github.com/airmessage/airmessage-server) |

[Android](https://github.com/airmessage/airmessage-android) |

[Connect (community)](https://github.com/airmessage/airmessage-connect-java)

## Getting started

To build AirMessage for web, you will need [Node.js](https://nodejs.org).

AirMessage for web uses [React](https://reactjs.org) and [TypeScript](https://www.typescriptlang.org). If you're not familiar with these tools, they both have great introductory guides:

- [React - Getting started](https://reactjs.org/docs/getting-started.html)

- [TypeScript for JavaScript Programmers](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html)

AirMessage for web uses a configuration file to associate with online services like Firebase and Sentry.

The app will not build without a valid configuration, so to get started quickly, you can copy the `src/secrets.default.ts` file to `src/secrets.ts` to use a pre-configured Firebase project, or you may provide your own Firebase configuration file.

To launch a development server, run `npm start`. To build a production-optimized bundle, run `npm run build`.

## Building and running for AirMessage Connect

In order to help developers get started quickly, we host a separate open-source version of AirMessage Connect at `connect-open.airmessage.org`.

The default configuration is pre-configured to authenticate and connect to this server.

Since this version of AirMessage Connect is hosted in a separate environment from official servers, you will have to be running a version of AirMessage Server that also connects to the same AirMessage Connect server.

We kindly ask that you do not use AirMessage's official Connect servers with any unofficial builds of AirMessage-compatible software.

---

Thank you for your interest in contributing to AirMessage!

You're helping to shape the future of an open, secure messaging market.

Should you have any questions, comments, or concerns, please shoot an email to [[email protected]](mailto:[email protected]).