| assets | ||
| data | ||
| dist | ||
| lib | ||
| pages | ||
| .gitignore | ||
| 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. The entry point is located in the main file. It should not be modified.
Add a page
To add a page, create a HTML file in the pages directory.
Optionally, you can inject data in the template. To do so you should create a TOML file with the same name as the
template.
Any fields will become available in the template.
For instance the index.toml for index.html could contain the following fields:
name = "index"
template = "index.html"
Layouts
You can use template inheritance. The layouts must be in the pages/layouts subdirectory.
Configuration
The configuration file (config.toml) is mandatory and should resemble:
name = "VillaFleurie"
Build site
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
- Use rich instead of logger
- Add file watching mode
Excluded
- The language switcher