mirror of
https://github.com/rjNemo/vf-site
synced 2026-06-06 01:16:38 +00:00
No description
| css | ||
| dist | ||
| images | ||
| js | ||
| lib | ||
| pages | ||
| templates | ||
| webfonts | ||
| .gitignore | ||
| article.html | ||
| config.toml | ||
| Makefile | ||
| Pipfile | ||
| Pipfile.lock | ||
| pyproject.toml | ||
| README.md | ||
VillaFleurie rental site
How to use
You can build the site using the built-in static site generator included.
To create a page, create a toml file in the pages directory. It should contain at least the following fields:
name = "index"
template = "index.html"
You can add other fields they will become available in the template.
The entry point is located in the main file. It should not be modified.
By default, the templates files are located in the templates directory. You can use template inheritance.
Configuration
The configuration file (config.toml) is mandatory and should resemble:
{
"name": "VillaFleurie",
"templatesDir": "templates",
"staticFilesDir": [],
"outDir": "dist"
}
Site Generation
You can generate the site by running:
python -m lib.main
How to run the website
It will generate the final files in the dist folder. You can run the output files using a simple python server:
cd dist && python -m http.server
Deployment
You can then deploy the site on any platform supporting static sites (Netlify,…) or your own VPS.
TODO
- Create a base template for the header and footer
- Build index page
- Build room pages
- T2
- T3
- Build contact pages
- Use netlify form for the contact form
- Deploy to VillaFleurie's domain
- Find attractions for landing page
- Pick real reviews from AirBnB and Booking
- Optimize images
- Automate the file search
- Extract data out of the template
- Create a 'all' key for data available in all templates
- Create a template for the rooms
- Build script before commit
- Lit parapluie, barbecue et machine à laver
Excluded
- The article page
- The language switcher