Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rumenpetrov/holiday-planner
Provides a list with all holidays in Bulgaria.
https://github.com/rumenpetrov/holiday-planner
astro bulgaria bulgarian holiday planner podman
Last synced: about 1 month ago
JSON representation
Provides a list with all holidays in Bulgaria.
- Host: GitHub
- URL: https://github.com/rumenpetrov/holiday-planner
- Owner: rumenpetrov
- Created: 2023-01-29T16:22:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-13T12:58:13.000Z (3 months ago)
- Last Synced: 2024-09-14T02:14:32.183Z (3 months ago)
- Topics: astro, bulgaria, bulgarian, holiday, planner, podman
- Language: Astro
- Homepage: https://rumenpetrov.github.io/holiday-planner/
- Size: 449 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# holiday-planner
This is a planner web app which provides information about all the holidays in Bulgaria.
## Check out the [Wiki](https://github.com/rumenpetrov/holiday-planner/wiki)
## Requirements
- node 18
- npm 9.8.1
- podman 4+
## Initial setup
1. Create the environment variables file and set all the required values
```bash
$ cp .env.example .env
```
2. Make all scripts executable and run the setup-env script which will create the app's podman image
```bash
$ chmod +x ./bin/*
$ ./bin/setup-env.sh
```
3. Run the app in dev mode (make sure port 3000 is free on your machine)
```bash
$ ./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](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).