Files
ncd-fe/docs/building/nicolium.md
nicole mikołajczyk de8ae5a949 Rename project to Nicolium
Signed-off-by: nicole mikołajczyk <git@mkljczk.pl>
2026-02-09 22:35:22 +01:00

31 lines
1.3 KiB
Markdown

# Building Nicolium
Building Nicolium requires [Node.js](https://nodejs.org/) and [pnpm](https://pnpm.io/) package manager to be installed. Since Node v16.13, Node.js comes with `corepack` pre-installed, which can be used to manage package managers like `pnpm`.
To enable `pnpm` using `corepack`, run the following command:
```bash
corepack enable pnpm
```
You can now proceed to fetching Nicolium Git repository, installing dependencies, and building the project:
```bash
# Clone the Nicolium repository
git clone https://codeberg.org/mkljczk/nicolium.git
cd nicolium
# Install dependencies
pnpm install
# Build the pl-api dependency
pnpm -F pl-api build
# Build the Nicolium project
pnpm -F pl-fe build
```
The built files will be located in the `packages/pl-fe/dist` directory. You can [serve them using a static web server](./installing/standalone.md).
Following environment variables can be used to customize the instance in build process:
- `BACKEND_URL` - URL of the Mastodon-compatible instance to connect to. If not set, tries fetching /api/v1/instance from the origin and falls back to standalone mode.
- `FE_SUBDIRECTORY` - The path where Nicolium is mounted to. Defaults to `/`.
- `WITH_LANDING_PAGE` - Displays the landing page on the home page, when running in standalone mode.