1.0.1 • Published 9 months ago
create-korzu-setup v1.0.1
create-korzu-setup
create-korzu-setup
is a setup tool to quickly create projects with both backend and frontend using either React or Vanilla JavaScript. This package automates the folder creation, installs necessary dependencies, and configures your environment so you can start developing immediately.
Installation
To install and use this package on any computer, follow these steps:
- Make sure you have Node.js installed on your machine.
- Run the following command to create a new project:
npm create korzu-setup my-app
Replace my-app with the name of your project.
Features
- Quick setup of backend and frontend.
- Option to choose between Vanilla JavaScript or React projects.
- Automatic installation of dependencies for both backend and frontend
How it works
Once you run the command, the script will:
- Ask for the project name.
- Let you choose between Vanilla or React for the frontend.
- Copy the backend and frontend boilerplates from the template.
- Install all required dependencies for both backend and frontend.
Usage
After the setup completes, follow these steps to start the project
Start Backend
- Navigate to the backend folder using
cd my-app/backend
- Start the backend with
npm start
Start Frontend
- Navigate to the frontend folder using
cd my-app/frontend
- Start the frontend with
npm start
License
This README.md
includes installation instructions, usage information, and an overview of the setup tool’s functionality, all in a simple and structured format for easy reading.