Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rachit-bharadwaj/next-starter
https://github.com/rachit-bharadwaj/next-starter
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/rachit-bharadwaj/next-starter
- Owner: rachit-bharadwaj
- Created: 2024-10-27T18:28:21.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-27T20:33:36.000Z (about 2 months ago)
- Last Synced: 2024-10-27T23:28:01.789Z (about 2 months ago)
- Language: TypeScript
- Size: 201 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @rachitbharadwaj/create-next-app
Create a new Next.js application quickly and easily with this CLI tool. This package provides a starter template for Next.js projects, enabling developers to get started without the hassle of manual setup.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## Installation
To create a new Next.js app using this CLI tool, you can use `npx`:
```bash
npx @rachitbharadwaj/create-next-app
```
Replace with the desired name for your new application. If no name is provided, it defaults to my-next-app.
## Usage
After running the command above, navigate into your new project directory:
```bash
cd
```
Then, you can start the development server:
```bash
npm run dev
```
Open your browser and visit http://localhost:3000 to see your new Next.js app in action!
## Features
- Quickly create a new Next.js application with the latest stable packages.
- Preconfigured with Tailwind CSS for styling.
- Support for TypeScript and other essential libraries.
- Optimized for best practices in Next.js development.
## Project Structure
Your new Next.js application will have the following folder structure, you can for sure modify it according to your needs:
```typescript
├── .next/
├── app/
│ ├── (main)/
│ ├── ├── layout.tsx
│ ├── ├── page.tsx
│ ├── globals.css
│ ├── layout.tsx
├── components/
├── constants/
├── containers/
├── contexts/
├── lib/
├── node_modules/
├── partials/
├── public/
├── types/
├── .eslintrc.json
├── .gitignore
├── components.json
├── next-env.d.ts
├── next.config.ts
├── package-lock.json
├── package.json
├── postcss.config.mjs
├── README.md
├── tailwind.config.ts
└── tsconfig.json
```
## Contributing
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch: git checkout -b my-feature.
- Make your changes and commit them: git commit -m 'Add my feature'.
- Push to the branch: git push origin my-feature.
- Submit a pull request.
## License
This project is licensed under the MIT License. See the LICENSE file for details.
For any issues or feature requests, please open an issue on the GitHub repository or contact me at [rachit.infornics.com/contact](https://rachit.infornics.com/contact).
Happy coding! 🚀