0.1.0 • Published 4 months ago

create-posk v0.1.0

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

POS Killer (POSK)

A zero-config SvelteKit project initializer with AWS infrastructure provisioning built-in.

Overview

POS Killer (POSK) is a command-line tool designed to simplify the process of setting up SvelteKit projects with AWS infrastructure. It provides a streamlined workflow for initializing, deploying, and managing SvelteKit applications on AWS services like Elastic Beanstalk, RDS, and S3.

Features

  • Project Initialization: Set up a new SvelteKit project with a single command
  • Database Integration: Configure PostgreSQL databases (local development requires PostgreSQL installation, or use AWS RDS)
  • S3 Storage: Set up and manage AWS S3 buckets for file storage using AWS CLI
  • Elastic Beanstalk Deployment: Deploy your SvelteKit application to AWS Elastic Beanstalk
  • Interactive Dashboard: View and manage your project's AWS resources through a web-based dashboard

Installation

npm install -g create-posk

Usage

Initialize a new project

create-posk init

This command will guide you through setting up a new SvelteKit project with optional AWS infrastructure.

Deploy to AWS

create-posk deploy

This command will build your SvelteKit project and deploy it to AWS Elastic Beanstalk.

View Dashboard

create-posk dashboard

This command will open a web-based dashboard showing your project's AWS resources and configuration.

Configuration

POSK stores your project configuration in a posk.json file in your project root. This file contains information about your project, database, S3 bucket, and Elastic Beanstalk deployment.

Requirements

  • Node.js 16 or higher
  • AWS CLI (for AWS-related features)
  • AWS account (for AWS-related features)
  • PostgreSQL (for local database development)

License

MIT