coldbrew/README.md
Kumi e1bf6b9901
feat: initialize project structure with core setup
Initial setup of the ColdBrew Django-based VPN manager project. Added basic project structure including core Django configurations and essential files:
- Added `.gitignore` to exclude unnecessary files from version control.
- Introduced `LICENSE` with MIT license.
- Created basic `README.md` with setup and contribution guidance.
- Configured Django project settings with auto-generated secrets.
- Implemented essential VPN management models, views, and admin settings.
- Integrated core dependencies like Django Rest Framework, Celery for task management, and Redis for caching.
- Added Poetry for dependency management along with necessary dependencies for development and database support.
2024-07-12 08:31:39 +02:00

13 lines
524 B
Markdown

# ColdBrew - A Django-based VPN manager.
## Setup Notes
1. Ensure that you have a rule in iptables that denies routing by default. ColdBrew will manage the rules for you, but it needs a rule to start from. If you don't have one, you can add one with `iptables -A FORWARD -j DROP`.
## Contributing
We welcome contributions to this project. Please see the [CONTRIBUTING](CONTRIBUTING.md) file for more information.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.