dev.to Neon-oss challenge winner. Neon OSS Kit is a collection of tools and services that help you build and scale your applications with Neon.
MIT License
Welcome to the official documentation for the Neon OSS Starter Kit. This documentation will guide you through the installation, setup, and usage of the Neon OSS Starter Kit.
To create a new project using the Neon OSS Starter Kit, you can use the following command:
npx @rohittcodes/neon-osskit@latest
Note: This command will create a new next project with Prisma ORM by default.
To create a new project with drizzle, you can use the following command:
npx @rohittcodes/neon-osskit@latest drizzle
for prisma again
npx @rohittcodes/neon-osskit@latest prisma
After creating a new project using the Neon OSS Starter Kit, you can follow the steps below to get started:
.env
fileDATABASE_URL="your-neon-database-url"
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your-clerk-publishable-key
CLERK_SECRET_KEY=your-clerk-secret-key
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
Delete the .git
folder and run git init
to initialize a new git repository for your project (if you want to use git)
Start the development server
pnpm dev
# or
yarn dev
# or
npm run dev
If you would like to contribute to the documentation, please follow the steps below:
git clone https://github.com/RohittCodes/neon-osskit.git
pnpm i
pnpm dev
git add .
git commit -m "Your commit message"
git push
If you have any questions or need help, please feel free to reach out to me on Twitter.
This project is licensed under the MIT License.