Skip to content

Commit f8c8a25

Browse files
committed
update readme
1 parent da47ee0 commit f8c8a25

File tree

2 files changed

+7
-59
lines changed

2 files changed

+7
-59
lines changed

.env.example

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
BASE_URL="/dc/calendar"
2+
ORIGIN="https://chazza.me"

README.md

Lines changed: 5 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -4,72 +4,18 @@ Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduct
44

55
## Setup
66

7-
Make sure to install dependencies:
7+
You'll need `docker` and `docker compose`.
88

99
```bash
10-
# npm
11-
npm install
12-
13-
# pnpm
14-
pnpm install
15-
16-
# yarn
17-
yarn install
18-
19-
# bun
20-
bun install
21-
```
22-
23-
## Development Server
24-
25-
Start the development server on `http://localhost:3000`:
26-
27-
```bash
28-
# npm
29-
npm run dev
30-
31-
# pnpm
32-
pnpm dev
33-
34-
# yarn
35-
yarn dev
36-
37-
# bun
38-
bun run dev
10+
docker compose up -d
3911
```
4012

4113
## Production
4214

43-
Build the application for production:
15+
The calendar is designed to be compatible with SSG, that means it can be generated and deployed to a static host.
4416

4517
```bash
46-
# npm
47-
npm run build
48-
49-
# pnpm
50-
pnpm build
51-
52-
# yarn
53-
yarn build
54-
55-
# bun
56-
bun run build
57-
```
58-
59-
Locally preview production build:
60-
61-
```bash
62-
# npm
63-
npm run preview
64-
65-
# pnpm
66-
pnpm preview
67-
68-
# yarn
69-
yarn preview
70-
71-
# bun
72-
bun run preview
18+
npm run generate
7319
```
7420

75-
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
21+
Follow the instructions to deploy the build to your static host.

0 commit comments

Comments
 (0)