Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
tagavari committed Jul 2, 2022
2 parents 600a535 + 0c2b23c commit 765864b
Show file tree
Hide file tree
Showing 206 changed files with 29,216 additions and 23,925 deletions.
34 changes: 0 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,6 @@ The app will not build without a valid configuration, so to get started quickly,

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

## File structure outline

- `/public` holds static files that are copied in at build time. It also holds the app's entry point, `index.html`.
- `/src` holds shared source files - where most of the UI logic resides.
- `/browser` holds all browser-specific code. This includes logic for authenticating with Firebase and using AirMessage's WebSocket proxy.
- `/windows/web` holds all web-side Windows-specific code.
- `/windows/AirMessageWindows` is a Visual Studio project that builds to AirMessage's Windows client.
- Builds are located in `/build` for web builds.

`/browser` and `/windows/web` are aliased to the import prefix `/platform-components` at build time, depending on the build target.
As such, components that are imported from `/src` must be available in both directories. If you're adding or modifying any files in these build-specific directories, please ensure that they are imported properly with the `/platform-components` alias.

Any extra files under build-specific directories (`/browser` or `/windows/web`) that aren't used by `/src` should be under a `private` subdirectory.

## 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`.
Expand All @@ -46,26 +32,6 @@ Since this version of AirMessage Connect is hosted in a separate environment fro

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

## Developing and running Windows builds

![AirMessage running on Windows](README/windows-app.png)

AirMessage is also able to run on Windows machines, with support for direct connections like the Android app.

Builds for web browsers and Windows will be kept in sync, so any changes made to files under the `/src` directory will make their way into the web app as well.

On top of the dependencies for AirMessage for web, AirMessage for Windows uses
[Visual Studio](https://visualstudio.microsoft.com/),
the [Windows App SDK](https://docs.microsoft.com/en-us/windows/apps/windows-app-sdk/),
and [Microsoft Edge WebView2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/).

To build and run, please make sure you have installed
[Visual Studio](https://visualstudio.microsoft.com/downloads/),
[prepared your PC for Windows app development](https://docs.microsoft.com/en-us/windows/apps/windows-app-sdk/set-up-your-development-environment),
and installed [Microsoft Edge WebView2](https://go.microsoft.com/fwlink/p/?LinkId=2124703).

Then, open the project in Visual Studio at `/windows/AirMessageWindows/AirMessageWindows.sln`, and run **AirMessageWindows (Package)**.

---

Thank you for your interest in contributing to AirMessage!
Expand Down
Binary file removed README/windows-app.png
Binary file not shown.
49 changes: 0 additions & 49 deletions browser/components/private/Onboarding.module.css

This file was deleted.

68 changes: 0 additions & 68 deletions browser/components/private/Onboarding.tsx

This file was deleted.

11 changes: 0 additions & 11 deletions browser/init.ts

This file was deleted.

1 change: 0 additions & 1 deletion index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ declare module "*.md" {

declare const WPEnv: {
ENVIRONMENT: "production" | "development";
IS_WEB: boolean;
PACKAGE_VERSION: string;
RELEASE_HASH: string | undefined;
BUILD_DATE: number;
Expand Down
6 changes: 6 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/* eslint-env node */
/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
module.exports = {
preset: "ts-jest",
testEnvironment: "jsdom",
};
Loading

0 comments on commit 765864b

Please sign in to comment.