Clarify a few things around running shared albums locally

Also, rename the environment variable to match what one would naturally type.
This commit is contained in:
Manav Rathi 2024-02-23 16:11:08 +05:30
parent 9859d4e723
commit 53a92a58e3
5 changed files with 28 additions and 10 deletions

View file

@ -44,12 +44,18 @@
# The URL for the shared albums deployment
#
# Currently the shared albums code is intermixed with the photos app code; when
# deploying, we add an a CNAME alias from "albums.ente.io" -> "/shared-album".
# The shared albums are served from the photos app code, and "albums.ente.io" is
# a CNAME alias to the main photo app itself. Depending on the query params, the
# root page redirects to "/shared-album".
#
# The port here will be :3002 if we run it using `yarn dev:albums`, and :3000 if
# we run it using `yarn dev:photos` (the code running the same is both cases,
# only the port it is exposed on is different).
#
# Enhancement: Consider splitting this into a separate app/ in this repository.
# That can also reduce bundle sizes and make it load faster.
#
# NEXT_PUBLIC_ENTE_ALBUM_ENDPOINT = http://localhost:3002
# NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT = http://localhost:3002
# The URL of the family plans web app deployment
#

View file

@ -0,0 +1,17 @@
# Develop against a server running on localhost
#
# Copy this file to `.env`. Then if you run a local instance of the web client
# with `yarn dev:photos`, it will connect to a locally running instance of the
# server. Not everything will work, you might need to set other env vars (see
# `.env.development`), but it should give you a usable baseline setup.
#
# Equivalent CLI command using environment variables would be
#
# NEXT_PUBLIC_ENTE_ENDPOINT=http://localhost:8080 NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT=http://localhost:3000 NEXT_PUBLIC_ENTE_DIRECT_UPLOAD=true yarn dev:photos
#
NEXT_PUBLIC_ENTE_ENDPOINT = http://localhost:8080
NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT = http://localhost:3000
# Uncomment this if running using yarn dev:albums
# NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT = http://localhost:3002
NEXT_PUBLIC_ENTE_DIRECT_UPLOAD = true

View file

@ -2,11 +2,6 @@
"name": "photos",
"version": "0.0.0",
"private": true,
"scripts": {
"dev": "next dev",
"build": "next build",
"albums": "next dev -p 3002"
},
"dependencies": {
"@/ui": "*",
"@/utils": "*",

View file

@ -17,7 +17,7 @@
"dev:auth": "yarn workspace auth next dev",
"dev:cast": "yarn workspace cast next dev",
"dev:photos": "yarn workspace photos next dev",
"albums": "yarn workspace photos albums",
"dev:albums": "yarn workspace photos next dev -p 3002",
"lint": "yarn prettier --check . && yarn workspaces run eslint .",
"lint-fix": "yarn prettier --write . && yarn workspaces run eslint --fix ."
},

View file

@ -79,7 +79,7 @@ export const getPaymentsURL = () => {
};
export const getAlbumsURL = () => {
const albumsURL = process.env.NEXT_PUBLIC_ENTE_ALBUM_ENDPOINT;
const albumsURL = process.env.NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT;
if (albumsURL) {
return albumsURL;
}