You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-1Lines changed: 54 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,6 @@ Clone the repository and run on the root folder:
11
11
pnpm i
12
12
pnpm dev
13
13
```
14
-
15
14
### Node.js Server
16
15
17
16
When running `nuxt build` with the Node server preset, the result will be an entry point that launches a ready-to-run Node server.
@@ -41,3 +40,57 @@ module.exports = {
41
40
Also, you can use different [presets](https://nuxt.com/docs/getting-started/deployment#hosting-providers). E.g. **Cloudflare Pages**: `cloudflare_pages`.
42
41
43
42
Note, some providers do not support server-side rendering.
43
+
44
+
---
45
+
46
+
### Docker Setup
47
+
48
+
You can also run the application in Docker.
49
+
Build the image and run the container:
50
+
```
51
+
docker build -t celenium-app
52
+
docker run -p 3000:3000 --env-file .env celenium-app
53
+
```
54
+
Make sure to create a ```.env``` file in the root directory or pass the required environment variables directly with ```-e```.
55
+
56
+
### Run with Docker Compose
57
+
Start with:
58
+
```
59
+
docker-compose up -d
60
+
```
61
+
62
+
By default:
63
+
- Builds the image from the local `Dockerfile`
64
+
- Runs the app on `127.0.0.1:3000`
65
+
- Automatically restarts the container on failure
66
+
- Uses `npm run start` as the startup command
67
+
- Limits logs (10 MB per file, max 5 files)
68
+
69
+
If you want to use a prebuilt image from **GitHub Container Registry**, specify a tag:
70
+
-`TAG=latest docker-compose up -d`
71
+
72
+
---
73
+
74
+
### Environment Variables
75
+
76
+
#### Required for App Startup
77
+
-**NUXT_PUBLIC_API_DEV** — indexer API (e.g. `https://api.localhost:9876/v1`).
-**NUXT_PUBLIC_SELFHOSTED** — set to `true` when running in self-hosted mode.
80
+
81
+
#### Blobstream Configuration
82
+
-**NUXT_PUBLIC_BLOBSTREAM_MAINNET** — API for blobstream data.
83
+
84
+
#### Faucet Configuration
85
+
-**NUXT_PUBLIC_FAUCET_ADDRESS** — faucet address.
86
+
-**NUXT_PUBLIC_FAUCET_MOCHA** — faucet API for the Mocha network.
87
+
-**NUXT_PUBLIC_FAUCET_ARABICA** — faucet API for the Arabica network.
88
+
-**NUXT_PUBLIC_FAUCET_MAMMOTH** — faucet API for the Mammoth network.
89
+
90
+
#### External Services Configuration
91
+
-**NUXT_PUBLIC_BLOCKSCOUT** — used to check whether a batch exists in Blockscout. If found, a dedicated button will appear on the blob form/page.
92
+
-**NUXT_PUBLIC_NODE_STATS** — provides statistics about node types, versions, and geographic distribution across the Celestia ecosystem.
93
+
-**NUXT_PUBLIC_QUOTE** — provides price data. It is used to display the current TIA price in the header and to convert all values from TIA to USD.
94
+
-**NUXT_PUBLIC_ROLLUP_RANKING** — fetches rollup ranking data displayed on the rollup leaderboard, individual rollup pages, and a dedicated rollup ranking page. The ranking page also includes detailed calculations, as well as repository and commit statistics.
95
+
-**NUXT_PUBLIC_GITHUB** — required for retrieving repository statistics on a rollup ranking page.
96
+
-**NUXT_PUBLIC_TVL** — provides TVL (Total Value Locked) statistics for rollups and TVS (Total Value Secured) for the Celestia network. These values are displayed in the header, on the statistics page, and on individual rollup pages.
0 commit comments