Skip to content

docs: add local setup instructions to README #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
artemkovalyov merged 1 commit into from
Aug 28, 2026
+17 −5
Merged

docs: add local setup instructions to README #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,25 @@ This is the official CobaltCore documentation.

## Requirements and Setup

### Docker Compose
Use **Local** if you have Node.js installed — it's faster and simpler.
Use **Docker** if you'd rather not install Node.js locally.

$ docker compose up
### Local

Run the above command to bring up an auto-refreshable development version of
the documentation. The documentation is accessible via
[http://localhost:5173/]().
Requires [Node.js](https://nodejs.org/) 18+.

```sh
npm install
npm run docs:dev
```

### Docker

```sh
docker compose up
```

In both cases the documentation is accessible at [http://localhost:5173/](http://localhost:5173/).

## Support, Feedback, Contributing

Expand Down