Mark Pitblado 9fe9111c18
align docs with frontend+api changes in 0.23.0
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.
2024-07-26 08:17:14 -07:00
.vscode initial commit 2024-06-19 19:59:36 +02:00
public fix: add security page 2024-07-08 17:35:07 +02:00
src align docs with frontend+api changes in 0.23.0 2024-07-26 08:17:14 -07:00
.drone.yml fix(ci): change secrets 2024-07-02 10:41:12 +02:00
.env.example feat: switch to node runtime 2024-06-27 21:30:54 +02:00
.envrc feat: add devenv 2024-06-24 16:18:39 +02:00
.gitattributes feat: make features page work 2024-06-24 10:59:33 +02:00
.gitignore feat: add devenv 2024-06-24 16:18:39 +02:00
astro.config.mjs feat: add heading links to text 2024-07-08 18:03:18 +02:00
devenv.lock feat: add devenv 2024-06-24 16:18:39 +02:00
devenv.nix feat: add wrangler cli 2024-06-27 16:25:31 +02:00
devenv.yaml feat: add devenv 2024-06-24 16:18:39 +02:00
Dockerfile feat: build it all in a docker container with nginx 2024-07-01 22:03:34 +02:00
markdoc.config.mjs feat: add heading links to text 2024-07-08 18:03:18 +02:00
nginx.conf Revert "feat: explicitly handle /api routes with nodejs" 2024-07-02 11:17:15 +02:00
package.json feat: add heading links to text 2024-07-08 18:03:18 +02:00
pnpm-lock.yaml feat: add heading links to text 2024-07-08 18:03:18 +02:00
README.md chore: update readme 2024-06-19 20:00:23 +02:00
run.sh feat: build it all in a docker container with nginx 2024-07-01 22:03:34 +02:00
tailwind.config.mjs feat: add heading links to text 2024-07-08 18:03:18 +02:00
tsconfig.json initial commit 2024-06-19 19:59:36 +02:00

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.