Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (chiks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
🐣 Hatch Your Next Project With Chiks. 🐣
Chiks is your one-stop solution for hatching modern web projects with ease!
Installation • Features • Usage • Updating • Uninstalling • Contributing
🚀 Installation
Make sure you have the following prerequisites installed:
- Docker
- PostgreSQL
Then, install Chiks globally:
npm install -g chiks✨ Features
🛠 Project Creation
Create a Next.js project or a Vite + Express project
🐳 Docker Integration
Automatically spins up a Docker container
🗄 Database Setup
Sets up a Prisma database and runs your first migration
🎨 Customization Options
- Choose your preferred auth integration
- Select your desired Docker port
- Opt for Tailwind CSS integration
✏️ Usage
- Open your terminal
- Navigate to your projects directory
- Run the following command:
chiks- Follow the prompts and watch your project hatch!
🔄 Updating
Keep Chiks up-to-date with a simple command:
npm update -g chiks🗑 Uninstalling
If you need to uninstall Chiks:
- Uninstall the package:
npm uninstall -g chiks- Remove the binary:
rm $(which chiks)NOTE: Due to npm v7+, uninstall scripts won't work, so the package's preuninstall script cannot remove the binary from your system. That's why you need to manually remove the binary as shown above.
🤝 Contributing
Please contribute!
We don't have a contributing guide yet, but we're working on it. In the meantime, feel free to open an issue or submit a pull request.
📄 License
This project is licensed under the MIT License - basically, do whatever you want as long as you give us credit.