78 lines
2.1 KiB
Markdown
78 lines
2.1 KiB
Markdown
# Worklenz - React Application
|
|
|
|
Worklenz is a task management application built with React and bundled using [Vite](https://vitejs.dev/).
|
|
|
|
## Table of Contents
|
|
- [Getting Started](#getting-started)
|
|
- [Available Scripts](#available-scripts)
|
|
- [Project Structure](#project-structure)
|
|
- [Contributing](#contributing)
|
|
- [Learn More](#learn-more)
|
|
|
|
## Getting Started
|
|
|
|
To get started with the project, follow these steps:
|
|
|
|
1. **Clone the repository**:
|
|
```bash
|
|
git clone https://github.com/Worklenz/worklenz-v2.git
|
|
```
|
|
2. **Navigate to the project directory**:
|
|
```bash
|
|
cd worklenz-v2
|
|
```
|
|
3. **Install dependencies**:
|
|
```bash
|
|
npm install
|
|
```
|
|
4. **Start the development server**:
|
|
```bash
|
|
npm run dev
|
|
```
|
|
5. Open [http://localhost:3000](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](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](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:
|
|
|
|
1. Fork the repository.
|
|
2. Create a new branch (`git checkout -b feature/YourFeatureName`).
|
|
3. Commit your changes (`git commit -m 'Add some feature'`).
|
|
4. Push to the branch (`git push origin feature/YourFeatureName`).
|
|
5. Open a pull request.
|
|
|
|
## Learn More
|
|
|
|
To learn more about Vite, check out the [Vite documentation](https://vitejs.dev/guide/).
|
|
|
|
To learn React, check out the [React documentation](https://reactjs.org/).
|