Welcome to S3-Kit, a highly opinionated template for building applications with Svelte, Drizzle, LibSQL, Tailwind, and shadcn/ui.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Before you begin, ensure you have met the following requirements:
- You have installed Node.js and pnpm.
- You have a
./.data/local.sqlite
file in your project root.
To install S3-Kit, follow these steps:
-
Clone the repo:
git clone https://github.com/d3ciee/s3-kit.git
-
Navigate to the project directory:
cd s3-kit
-
Install the dependencies:
pnpm install
- Create a
.env
file in your project root and add your environment variables as described in.env.example
.
To set up your database, run the following commands:
-
Generate migrations:
pnpm migrations:generate
-
Push migrations:
pnpm migrations:push
After following these steps, you should be able to start the development server:
pnpm run dev
To contribute to S3-Kit, follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>/<location>
- Create the pull request.
If you want to contact me, you can reach me at [email protected]
.
This project uses the following license: MIT
.