Get started
Local development
Install the lockfile and run Vite on port 2499.
git clone https://github.com/lucas-lepajollec/AstroGuide.git
cd AstroGuide
npm ci --include=optional
npm run devBy default, the application is available only at http://127.0.0.1:2499. To test it from another device on the local network, run npm run dev:lan and open the network address shown by Vite.
Useful commands
| Command | Purpose |
|---|---|
npm run dev | normal product |
npm run dev:lan | normal product available on the local network |
npm run dev:demo | same application in demo mode |
npm run dev:demo:lan | demo mode available on the local network |
npm run check | lint, TypeScript, tests, product build and demo build |
npm run preview | preview dist/ after a build |
Local demo mode
npm run dev:demoThis is not the default mode. It adds the welcome screen, demo badge and reset control. See Demo mode for details. To open it from another local device, use npm run dev:demo:lan.
Do not commit dist/
dist/, node_modules/ and .env* are ignored. A pull request must not contain them.