Skip to content

feat: update README #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matthieubosquet merged 1 commit into from
Nov 5, 2025
Merged

feat: update README #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,18 @@ For example, you can signup for a WebID at https://start.inrupt.com/.

## Setting Environment Variables

Before running the app, you need to set the `NEXT_PUBLIC_ADMIN_WEBID` environment variable.
Before running the app, set the `NEXT_PUBLIC_ADMIN_WEBID` and `NEXT_PUBLIC_OIDC_ISSUER` environment variable in `.env.local`.

This project includes a `.env.example` file with placeholders for the environment variables used by the app: `NEXT_PUBLIC_BASE_URI`, `NEXT_PUBLIC_MANIFEST_RESOURCE_URI`, and `NEXT_PUBLIC_ADMIN_WEBID`.
Environment variables
---------------------

Copy the `.env.example` to `.env` and edit the values before running the app.
This project includes a `.env.example` file with the placeholders for environment variables used by the app:
- `NEXT_PUBLIC_BASE_URI` - Base URI for the Solid server
- `NEXT_PUBLIC_MANIFEST_RESOURCE_URI` - URI for the manifest resource
- `NEXT_PUBLIC_ADMIN_WEBID` - WebID of the admin user
- `NEXT_PUBLIC_OIDC_ISSUER` - OIDC issuer URL for authentication (e.g., `https://login.inrupt.com`)

Copy the example to a local env file and edit values before running the app

Note: `.env` and `.env.local` are ignored by git (see `.gitignore`).

Expand Down