Skip to content

Latest commit

 

History

History
118 lines (85 loc) · 4.62 KB

README.md

File metadata and controls

118 lines (85 loc) · 4.62 KB

Next Boilerplate

A modern, feature-rich boilerplate for building scalable web applications with Next.js.

Features 🌟

Screenshots 📸

Home

Screenshot 0

Screenshot 2

Dark Mode

Screenshot 1

Features Page

Screenshot 3

Pricing Page

Screenshot 4

Support Page

Screenshot 5

Profile Page

Screenshot 7

Sign Up Page

Screenshot 6

Login Page

Screenshot 8

Getting Started 🚀

  1. Clone the repository:
git clone https://github.com/rafaelfagundes/next-boilerplate.git
cd next-boilerplate
  1. Install the dependencies:
npm install
  1. Set up the environment variables

  2. Generate the NextAuth Secret:

openssl rand -base64 32
  1. Start the development server:
npm run dev

Open http://localhost:3000 in your browser to see the result.

Project Structure 📁

src/ ├── app/ # App Router pages and layouts ├── components/ # Reusable UI components ├── lib/ # Utility functions and shared logic ├── styles/ # Global styles and Tailwind config └── types/ # TypeScript type definitions

Available Scripts 📜

  • npm run dev: Start the development server
  • npm run build: Build the production application
  • npm start: Start the production server
  • npm run lint: Run ESLint
  • npm run format: Format code with Prettier
  • npm run db:migrate: Run database migrations
  • npm run db:push: Push database migrations to the database
  • npm run db:studio: Open the database migration studio

VS Code Integration 🛠️

This project includes recommended VS Code extensions for an optimal development experience. To install them:

  • Open the Extensions view in VS Code (Ctrl+Shift+X)
  • Search for "@recommended" in the extensions search bar
  • Install the workspace recommended extensions

Learn More 📚

To learn more about the technologies used in this boilerplate, check out the following resources: