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

34 lines
1.1 KiB
Markdown
Raw Normal View History

Add README for Private.coffee website project 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.
2024-02-15 15:11:54 +00:00
# Private.coffee Website
feat(README): add support badge Introduced a new "Support Us!" badge to the README.md to encourage contributions and support for Private.coffee. This badge not only visually enhances the repository's appeal but also provides a direct link for potential supporters to contribute, fostering a stronger community engagement. The badge leverages custom styling and is powered by Private.coffee's own badge service, ensuring consistency with the project's branding and identity. This addition aligns with efforts to increase visibility and support for our open-source work.
2024-04-17 07:38:03 +00:00
[![Support Private.coffee!](https://shields.private.coffee/badge/private.coffee-Support%20us!-pink?logo=coffeescript)](https://private.coffee)
Add README for Private.coffee website project 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.
2024-02-15 15:11:54 +00:00
This is the source code for the [Private.coffee](https://private.coffee)
website.
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 08:50:00 +00:00
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.
Add README for Private.coffee website project 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.
2024-02-15 15:11:54 +00:00
## 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
```
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 08:50:00 +00:00
The website will be built into the `build` directory, and you can view it by
feat: add built-in HTTP server to preview static site 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.
2024-07-10 07:37:55 +00:00
opening the `index.html` file in your browser or using the included HTTP server
(`python main.py --serve`).
Add README for Private.coffee website project 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.
2024-02-15 15:11:54 +00:00
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE)
file for details.
feat: add service icons and clean up templates Updated `services.json` to include icon data for better visual identification of services. Also, removed unused services (Nitter and Proxigram) to streamline service offerings and improve maintainability. In `index.html`, amended the template to dynamically display these icons, enhancing the UI/UX. This change makes the service list more visually appealing and intuitive, directly linking visual cues to services for quicker recognition. Additionally, this update contributes to a cleaner codebase by removing references to services no longer in use, thus improving code quality and reducing potential confusion regarding supported services.
2024-05-29 13:33:18 +00:00
## Attribution
This website is built using the [Bootstrap](https://getbootstrap.com) framework
and [Phosphor Icons](https://phosphoricons.com).
Reference in a new issue Copy permalink