Hackathon Boilerplate is a powerful Next.js starter kit designed to accelerate your development process with a robust set of features.
This project aims to provide a comprehensive foundation for building scalable web applications quickly and efficiently. The core features include:
- ⚙ Next.js Configuration: Streamlines development with customizable settings enhancing performance and adherence to best practices.
- 🔒 Authentication Middleware: Ensures secure access to protected routes improving user experience through seamless session management.
- 🎨 Tailwind CSS Integration: Facilitates responsive design with a utility-first approach making styling efficient and maintainable.
- 👥 Robust User Management: Includes user authentication account linking and subscription management enhancing user interactions.
- 🔄 Dynamic Components: Offers reusable Ul components for navigation forms and feedback promoting a cohesive user experience.
- 📁 File Upload Functionality: Simplifies file management with integrated upload capabilities enhancing overall application functionality.
This project requires the following dependencies:
- Runtime: NodeJS
1. Clone the repository:
git clone https://github.com/Fivlas/hackhaton-boilerplate.git
2. Navigate to the project directory:
cd hackhaton-boilerplate
3. Install the dependiences
npm install
4. Create and fill .env file
DATABASE_URL=
BETTER_AUTH_SECRET=
BETTER_AUTH_URL=
SMTP_SERVER_USERNAME=
SMTP_SERVER_PASSWORD=
SMTP_SERVER_HOST=
#Default email reciver
SITE_MAIL_RECIEVER=
STRIPE_SECRET_KEY=
STRIPE_WEBHOOK_SECRET=
#From https://uploadthing.com/
UPLOADTHING_TOKEN=
UPLOADTHING_SECRET=
5. Generate Prisma Scheme
npx prisma generate
6. Push Prisma Scheme to DB
npx prisma db push
7. Run Stripe webhook
stripe listen --forward-to localhost:3000/api/auth/stripe/webhook
8. Run Project
npm run dev
Technologies used in the project:
- NextJs
- TypeScript
- Prisma
- ShadCN
- BetterAuth
- TailwindCSS
- Stripe
- React Hook Form
- zod
- nodemailer
- motion.js
This project is licensed under the MIT