Kumi
a684c8b9df
Some checks failed
Build and Deploy Static Site / build (push) Has been cancelled
Introduced a new option `--serve` in `main.py` to provide an HTTP server for previewing the static site. Updated README with usage instructions. This enhancement allows users to quickly view the site on localhost without manually opening the `index.html` file. Addresses usability improvements for local development.
34 lines
No EOL
1.1 KiB
Markdown
34 lines
No EOL
1.1 KiB
Markdown
# Private.coffee Website
|
|
|
|
[](https://private.coffee)
|
|
|
|
This is the source code for the [Private.coffee](https://private.coffee)
|
|
website.
|
|
|
|
It is a simple Jinja2 static website generator that compiles the templates in
|
|
the `templates` directory in conjunction with the JSON files in the `data`
|
|
directory to generate the static HTML files in the `build` directory.
|
|
|
|
## Development
|
|
|
|
To run the website locally, you will need to have Python 3 installed. Then, you
|
|
can install the dependencies and run the website with the following commands:
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
python main.py
|
|
```
|
|
|
|
The website will be built into the `build` directory, and you can view it by
|
|
opening the `index.html` file in your browser or using the included HTTP server
|
|
(`python main.py --serve`).
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE)
|
|
file for details.
|
|
|
|
## Attribution
|
|
|
|
This website is built using the [Bootstrap](https://getbootstrap.com) framework
|
|
and [Phosphor Icons](https://phosphoricons.com). |