Karl/homepage
1
0
Fork 0
mirror of https://github.com/karl0ss/homepage.git synced 2025-04-29 12:03:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

update readme with node instructions

Browse Source
This commit is contained in:
Ben Phelps 2022-08-25 14:19:21 +03:00
parent affd1e97c2
commit c90f781650
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -17,6 +17,10 @@
## Getting Started ## Getting Started
You can run the homepage from a docker container or locally using node.
### With Docker
Using docker compose: Using docker compose:
```yaml ```yaml
@ -37,6 +41,27 @@ or docker run:
docker run -p 3000:3000 -v /path/to/config:/app/config ghcr.io/benphelps/homepage:main docker run -p 3000:3000 -v /path/to/config:/app/config ghcr.io/benphelps/homepage:main
``` ```
### With Node
First, clone the repository:
```bash
git clone https://github.com/benphelps/homepage.git
```
Then install dependencies and build the production bundle (I'm using pnpm here, you can use npm or yarn if you like):
```bash
pnpm install
pnpm build
```
Finally, run the server:
```bash
pnpm start
```
## Configuration ## Configuration
Configuration files will be genereted and placed on the first request. Configuration files will be genereted and placed on the first request.
@ -59,3 +84,5 @@ pnpm dev
``` ```
Open [http://localhost:3000](http://localhost:3000) to start. Open [http://localhost:3000](http://localhost:3000) to start.
This is a [Next.js](https://nextjs.org/) application, see their doucmentation for more information: