privatecoffee-website/README.md

31 lines
932 B
Markdown
Raw Normal View History

# 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 Flask application that generates the HTML for the website based
on the services defined in the `services.json` file.
## 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 available at `http://localhost:9810`.
## 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).