Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raphaeleliass/my-next-project-starter
A fully customizable boilerplate for Next.js projects, designed to help developers kickstart their applications with best practices and modern tools. Includes pre-configured setups for styling, routing, state management, and more, making it an ideal starting point for any web development project.
https://github.com/raphaeleliass/my-next-project-starter
boilerplate boilerplate-template next react seo shadcn-ui tailwindcss
Last synced: 3 days ago
JSON representation
A fully customizable boilerplate for Next.js projects, designed to help developers kickstart their applications with best practices and modern tools. Includes pre-configured setups for styling, routing, state management, and more, making it an ideal starting point for any web development project.
- Host: GitHub
- URL: https://github.com/raphaeleliass/my-next-project-starter
- Owner: raphaeleliass
- Created: 2024-12-22T14:42:54.000Z (4 days ago)
- Default Branch: master
- Last Pushed: 2024-12-22T16:23:53.000Z (4 days ago)
- Last Synced: 2024-12-22T17:24:19.291Z (4 days ago)
- Topics: boilerplate, boilerplate-template, next, react, seo, shadcn-ui, tailwindcss
- Language: TypeScript
- Homepage:
- Size: 56.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **Next Project Boilerplate**
### 🚀 Kickstart Your Next.js Project with Ease
This boilerplate provides essential configurations and optimizations for building scalable Next.js applications. It comes pre-configured with Tailwind CSS for styling, ShadCN UI for components, and metadata for enhanced SEO, saving you time and effort.
## **Project Dependencies**
This boilerplate includes the following tools and frameworks:
- **TypeScript**: Strongly typed JavaScript for better developer experience.
- **Tailwind CSS**: Utility-first CSS framework for rapid UI development.
- **ShadCN UI**: Pre-built and customizable UI components.
- **Next Router**: Powerful and flexible routing solution.
- **ESLint**: Enforces code quality and consistency.
## **Getting Started**
Follow these steps to get the project up and running on your local machine:
### 1. Clone this repository
Run the following command in your terminal:
```bash
git clone https://github.com/raphaeleliass/my-next-project-starter
```
### 2. Navigate to the project folder
Use the cd command to move into the project directory:
```bash
cd my-next-project-starter
```
### 3. Install dependencies
Use the cd command to move into the project directory:
```bash
npm install
# or
pnpm install
# or
yarn install
```
### 4. Install development server
Run the development server
```bash
npm run dev
# or
pnpm run dev
# or
yarn run dev
```
🎉 **Congratulations!** You're all set to start developing your project.
---
## ShadCN UI Instructions
This boilerplate includes a few pre-configured ShadCN components:
- **button**
- **card**
### 1. Adding more components
To add additional components, use the following commands:
```bash
npx shadcn@latest add component-name
# or
pnpm dlx shadcn@latest add component-name
```
### 2. Adding All Components
To install all available ShadCN components, use:
```bash
npx shadcn@latest add --all
# or
pnpm dlx shadcn@latest add --all
```
### 3. Documentation
For detailed instructions and component usage, check out the [**ShadCN UI documentation**](https://ui.shadcn.com/docs/installation).
# 💡 **Tips**
- Use this boilerplate as a foundation for your next project to save time and focus on building features.
- Star this repository if you find it useful!