prefiq-installer 1.1.0

CLI installer for Prefiq – scaffolding, bootstrapping, and app/site management.

Prefiq CLI

Modern Full-Stack App Scaffolding Tool
Build, manage, and scale modular Python projects with ease.

---

1. Install Prefiq

pip install prefiq

Or use the installer script:

python install_prefiq.py

2. Create a New Project

prefiq install sundar

This sets up the sundar/ project folder with:

• ✅ Python virtual environment (venv/)
• ✅ Standard files: requirements.txt, README.md, LICENSE, .gitignore
• ✅ Base framework folder: prefentity/

---

📁 Create Apps Using Templates

Inside your project folder:

cd sundar

▶️ Full App Scaffold

prefiq new-app crm

Creates a full app at apps/crm/ with:

apps/
└── crm/
    ├── app.py
    ├── config.py
    ├── assets/
    ├── templates/
    ├── routes/
    ├── logic/
    ├── database/
    └── ...

⚡ Base (Minimal) App Scaffold

prefiq new-app auth --base

Generates only the essential app folders and files.

♻️ Force Overwrite an Existing App

prefiq new-app blog --force

This will overwrite the existing apps/blog folder.

---

🧩 Manage Apps

List Registered Apps

prefiq list-apps

Remove an App

prefiq remove-app blog

This will remove the folder and update prefentity/manifest.json.

---

🛠️ Features

• Modular app structure
• Plug-and-play scaffold templates
• Configurable base (--base) or full app generation
• Virtual environment setup
• Standardized project bootstrapping
• JSON-based app registry (manifest.json)

---

📈 Project Stats

• Latest Version: v0.1.0
• PyPI Downloads: 10,000+ (placeholder)
• GitHub Stars: ⭐ 500+ (placeholder)

---

🤝 Contributing

We welcome contributions! To get started:

1. Fork this repository
2. Create a feature branch
3. Submit a pull request

Make sure your code passes all existing tests and includes new ones as necessary.

Run Locally

git clone https://github.com/PREFIQ/prefiq-py-cli.git
cd prefiq-py-cli
pip install -e .

---

📜 License

This project is licensed under the MIT License.

---

🔐 Security Policy

If you discover a vulnerability, please submit an issue or contact us directly. See SECURITY.md for guidelines.

---

📬 Contact

For support or questions, reach out via GitHub issues or email us at [e-mail].

---

Built with passion by the Prefiq engineering team.