PrivateCoffee/privatecoffee-website
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add README for Private.coffee website project

Browse source 
Introduced a README file to provide basic documentation for the
Private.coffee website. This includes instructions on setting up a
development environment, running the site locally, and the licensing
information, thereby facilitating easier onboarding and contribution to
the project. The README ensures clarity on the project's structure which
is centered around a Flask application using a `services.json`
configuration.
This commit is contained in:
Kumi 2024-02-15 16:11:54 +01:00
parent 66f544a29f
commit a108b961bf
Signed by: kumi
GPG key ID: ECBCC9082395383F
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md Normal file
View file

@ -0,0 +1,24 @@
# Private.coffee Website
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.