Welcome to the React Project Starter Kit documentation! This guide will help you set up and start a new React project quickly. Follow the steps below to get your project up and running.
- Node.js: Download and Install Node.js
- npm (Node Package Manager): npm comes with Node.js, so no need for a separate installation.
- Clone the Repository
git clone https://github.com/your-username/your-react-project.git
cd your-react-project
- Install Dependencies:
npm i
- Start Server
npm run dev
- Start Development Server:
npm run dev
- This command runs the app in development mode. Open http://localhost:5173/ to view it in the browser.
- Build for Production:
npm run build
- Builds the app for production to the build folder. The build is minified and optimized for better performance.
- Run Tests:
npm run test
- Launches the test runner in interactive watch mode.
The project structure is organized as follows:
-
public: Static assets and the index.html file.
-
src: Source code for your React application.
- components: Reusable React components.
- styles : CSS or other styling files.
- App.js: Main component where your app starts.
- index.js: Entry point for your React application.