holiday-planner

This is a planner web app which provides information about all the holidays in Bulgaria.

Check out the Wiki

Requirements

• node 18
• npm 9.8.1
• podman 4+

Initial setup

1. Create the environment variables file and set all the required values

$ cp .env.example .env

2. Make all scripts excutable and run the setup-env script which will create the app's podman image

$ chmod +x ./bin/*
$ ./bin/setup-env.sh

3. Run the app in dev mode (make sure port 3000 is free on your machine)

$ ./bin/start.sh

🚀 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:3000
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.