2.1 KiB
Worklenz - React Application
Worklenz is a task management application built with React and bundled using Vite.
Table of Contents
Getting Started
To get started with the project, follow these steps:
- Clone the repository:
git clone https://github.com/Worklenz/worklenz-v2.git - Navigate to the project directory:
cd worklenz-v2 - Install dependencies:
npm install - Start the development server:
npm run dev - Open http://localhost:3000 in your browser to view the application.
Available Scripts
In the project directory, you can run:
npm run dev
Runs the app in the development mode.
Open http://localhost:5173 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
npm run build
Builds the app for production to the dist folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
npm run preview
Serves the production build locally for testing.
Open http://localhost:4173 to preview the build.
Project Structure
The project structure is organized as follows:
Contributing
Contributions are welcome! If you'd like to contribute, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature/YourFeatureName). - Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature/YourFeatureName). - Open a pull request.
Learn More
To learn more about Vite, check out the Vite documentation.
To learn React, check out the React documentation.