forked from vikunja/website
Mark Pitblado
9fe9111c18
Since the frontend and api containers were combine in 0.23.0 this updates the documentation to reflect this. For the updates made to Caddy, the current instructions will not work without these changes. The other two changes were explanatory text for database types that likely also should be changed as part of this effort. |
||
|---|---|---|
| .vscode | ||
| public | ||
| src | ||
| .drone.yml | ||
| .env.example | ||
| .envrc | ||
| .gitattributes | ||
| .gitignore | ||
| astro.config.mjs | ||
| devenv.lock | ||
| devenv.nix | ||
| devenv.yaml | ||
| Dockerfile | ||
| markdoc.config.mjs | ||
| nginx.conf | ||
| package.json | ||
| pnpm-lock.yaml | ||
| README.md | ||
| run.sh | ||
| tailwind.config.mjs | ||
| tsconfig.json | ||
Vikunja Homepage
This project holds the source code for the Vikunja homepage at vikunja.io.
🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.json
Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.
There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the public/ directory.
🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
👀 Want to learn more?
Feel free to check our documentation or jump into our Discord server.