privatecoffee-website/README.md
Kumi 69ef1f7a1a
All checks were successful
Build and Deploy Static Site / build (push) Successful in 1m0s
feat: update README and asset paths for static site generation
Switched the project description from a Flask application to a Jinja2 static website generator. Adjusted asset links in the base template to be relative, enhancing portability and simplifying deployments. These changes aim to better reflect the project's current architecture and usage.
2024-07-01 10:50:00 +02:00

33 lines
No EOL
1.1 KiB
Markdown

# Private.coffee Website
[![Support Private.coffee!](https://shields.private.coffee/badge/private.coffee-Support%20us!-pink?logo=coffeescript)](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.
## 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).