Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 2.16 KB

README.md

File metadata and controls

93 lines (64 loc) · 2.16 KB
Raw

kit (Keep in Touch)

With kit (Keep in Touch), staying engaged with your users and promoting your product has never been easier.

Open kit

Features

  • Blog with RSS feed
  • Email lead capture
  • Simple no-code landing page for your project
  • Integration with faith.tools
  • HTMX + Alpine.js for interactivity
  • Astro DB (Turso) for data storage
  • Clerk authentication
  • Cloudinary image management

Prerequisites

  • Node.js v20.3.0 or higher
  • NPM v10.0.0 or higher
  • Clerk account
  • Turso account
  • Cloudinary account
  • Netlify account (recommended for deployment)

Quick Start

  1. Clone the repository
git clone https://github.com/cameronapak/kit.git
  1. Install dependencies
npm install
  1. Set up environment variables
cp .env.example .env
  1. Start development server
npm run dev

Available Scripts

  • npm run dev - Start development server
  • npm run dev:remote - Start with remote database
  • npm run dev:host - Start with network access
  • npm run build - Build for production
  • npm run preview - Preview production build
  • npm run db:update - Update database schema
  • npm run format - Format code with Prettier
  • npm run update-packages - Update all packages

Tech Stack

For a deeper dive into this tech stack, see the Freedom Stack.

Deployment

This project is optimized for deployment on Netlify.

Contributing

See CONTRIBUTING.md for guidelines.

Support

Feel free to reach out on X/Twitter or open an issue.

License

While this project was initially licensed under the Attribution License, it has since been relicensed under the MIT License and is freely available for anyone to use.

This project is licensed under the MIT License - see LICENSE.md