JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q27460F
  • License MIT

An opensource (hopefully) application boilerplate script written in Golang.

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. 🐣

    npm version License: MIT Downloads

    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

    • Full Stack
      • Next.js
      • Vite + Express
    • Frontend Only
      • Next.js
      • Vite

    🐳 Docker Integration

    Automatically spins up a Docker container

    🗄 Database Setup

    Sets up a PostgreSQL database (Prisma ORM) and runs your first migration

    🎨 Customization Options

    • Choose your preferred auth integration
    • Opt for a database, or not
    • Select your desired Docker port
    • Opt for Tailwind CSS integration
      • Additional UI framework options:
        • Shadcn UI
        • DaisyUI

    📝 Usage

    1. Open your terminal
    2. Navigate to your projects directory
    3. Run the following command:
    chiks
    1. 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:

    1. Uninstall the package:
    npm uninstall -g chiks
    1. 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 have a contributing guide! Check it out here. This is especially important if you want to add a new stack to Chiks.

    📄 License

    This project is licensed under the MIT License - basically, do whatever you want as long as you give us credit.

    Made with ❤️ by the Chiks team