beenull/ente
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
ente/web/README.md
Manav Rathi ff5fbf3984
Update README
2024-05-16 21:42:03 +05:30

2.9 KiB
Raw Permalink Blame History

Ente's web apps

Source code for Ente's various web apps and supporting websites.

Live versions are at:

To know more about Ente, see our main README or visit ente.io.

Building from source

Fetch submodules

git submodule update --init --recursive

Install dependencies

yarn install

Start a local development server

yarn dev

That's it. The web app will automatically hot reload when you make changes.

Tip

If you're new to web development and unsure about how to get started, or are facing some problems when running the above steps, see docs/new.

Other apps

By default, yarn dev builds the Photos app. You can build the auth app by doing yarn dev:auth.

To see the full list of apps you can run (and other scripts that you can use), use yarn run.

For more details about development workflows, see docs/dev.

Directory structure

As a brief overview, this directory contains the following apps:

  • apps/photos: A fully functional web client for Ente Photos.
  • apps/auth: A view only client for Ente Auth. Currently you can only view your 2FA codes using this web app. For adding and editing your 2FA codes, please use the Ente Auth mobile/desktop app instead.

These are the public facing apps. There are other part of the code which are accessed as features within the main apps, but in terms of code are independently maintained and deployed:

  • apps/accounts: Passkey support (Coming soon)
  • apps/cast: Browser and Chromecast casting support.
  • apps/payments: Handle subscription payments.

Note

Some older code is being deployed from our other repositories like the family portal (https://github.com/ente-io/families) and still needs to be brought here. Likewise, some of the Cloudflare workers we use for fixing headers etc. We'll gradually bring all these into this monorepo one by one.

The apps take use various packages/ to share code amongst themselves.

You might also find this overview of dependencies useful.

Attributions

City coordinates from Simple Maps

🌍 Translate

Crowdin

If you're interested in helping out with translation, please visit our Crowdin project to get started. Thank you for your support.

If your language is not listed for translation, please create a GitHub issue to have it added.

Contribute

For more ways to contribute, see ../CONTRIBUTING.md.