https://github.com/tomek-i/nextjs-project-template-cli
npx command to create a local project from the nexttjs-template-starter
https://github.com/tomek-i/nextjs-project-template-cli
Last synced: 3 months ago
JSON representation
npx command to create a local project from the nexttjs-template-starter
- Host: GitHub
- URL: https://github.com/tomek-i/nextjs-project-template-cli
- Owner: tomek-i
- License: mit
- Created: 2025-02-25T10:33:02.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-25T11:02:13.000Z (3 months ago)
- Last Synced: 2025-02-25T11:36:33.897Z (3 months ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Next.js Project Starter
This script helps you quickly set up a new project using the [Next.js Project Template](https://github.com/tomek-i/nextjs-project-template). It automates the process of creating a new project based on the template repository.
## Installation
You can run the script globally using `npx`.
### Run the following command:
```bash
npx @tomek-i/nextjs-starter
```
## Usage
1. **Create a new project**:
Run the script with a project name to set up your new Next.js project based on the template.
Example:
```bash
npx @tomek-i/nextjs-starter my-new-project
```
2. **Project structure**:
After running the script, you'll have a new Next.js project with the same structure and configuration as the [template](https://github.com/tomek-i/nextjs-project-template).
3. **Development**:
Once the setup is complete, navigate into your project folder and run the development server:
```bash
yarn dev
```
4. **Ready for customization**:
Now you're ready to customize and start building your application with the Next.js template.
## Contributing
Feel free to submit issues and pull requests if you find any bugs or want to add new features to this setup script.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.