https://github.com/chalet-org/chalet-docs
Chalet documentation website in NextJs
https://github.com/chalet-org/chalet-docs
build-system c cpp cross-platform json mdx nextjs react
Last synced: about 2 months ago
JSON representation
Chalet documentation website in NextJs
- Host: GitHub
- URL: https://github.com/chalet-org/chalet-docs
- Owner: chalet-org
- License: other
- Created: 2021-01-16T18:24:12.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2026-02-06T05:32:08.000Z (2 months ago)
- Last Synced: 2026-02-06T14:05:16.999Z (2 months ago)
- Topics: build-system, c, cpp, cross-platform, json, mdx, nextjs, react
- Language: TypeScript
- Homepage: https://www.chalet-work.space
- Size: 6.73 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
## Website & documentation
## Development environment
---
1. Create a GitHub access token with repository access
2. Create `.env.local` at the root with:
```
USE_SERVER_CACHE=1
PRINT_SERVER_CACHE_LOG=1
# NEXT_PUBLIC_API_BASE=http://localhost:3000/api
NEXT_PUBLIC_API_TOKEN=
NEXT_PUBLIC_CRONITOR_CLIENT_ID=
GITHUB_TOKEN=
```
3. Add necessary tokens:
- `USE_SERVER_CACHE` must contain a `1` to use the server's memory cache. Caching will be disabled in development otherwise
- `PRINT_SERVER_CACHE_LOG` must contain `1` to print the server cache log. This can be exhaustive, so it may be worth disabling
- `GITHUB_TOKEN` should have access to `github.com/chalet-org/chalet`
- `NEXT_PUBLIC_API_TOKEN` can be anything while in the development environment. It just ensures the api can only be used by the website itself.
- `NEXT_PUBLIC_CRONITOR_CLIENT_ID` is optional - it's used for basic site analytics in production (page visits & downloads)
- `NEXT_PUBLIC_API_BASE` is optional. It falls back to `http://localhost:3000/api`
4. run:
```
pnpm run install
pnpm run start
```
5. Test GITHUB_TOKEN by going to `localhost:3000/api/schema/latest/settings-json` (this is a public endpoint)
## To test for production
---
Instead of `pnpm run start`, run `pnpm run build && pnpm run serve`