Skip to content

README.md

Latest commit

 

History

History
67 lines (42 loc) · 1.61 KB

README.md

File metadata and controls

67 lines (42 loc) · 1.61 KB

TeddyCloudStarter

Python 3.6+ License: GPL-3.0

A user-friendly wizard for setting up TeddyCloud deployments with Docker.

ALPHA - RELEASE

WARNING - Very early development stage Keep in mind that this project by far is not finished yet. But it should bring you the concept of how it will work.

Soon™

📋 Requirements

  • Python 3.6 or newer
  • Docker and Docker Compose
  • Internet connection (for first-time setup and updates)

🚀 Installation

Using pip

pip install TeddyCloudStarter

From source

git clone https://github.com/Quentendo64/TeddyCloudStarter.git
cd TeddyCloudStarter
pip install -e .

💻 Usage

Starting the wizard

TeddyCloudStarter

The wizard will guide you through the setup process with an interactive interface.

👏 Special Mentions

Special thanks to:

  • henryk from Revoxx Forum - For extensive testing and heroic support during development

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.