Update environment configuration, Docker setup, and frontend/backend dependencies

- Updated .env.example and .env files for backend and frontend with placeholder values.
- Enhanced .gitignore to include additional files and directories.
- Modified docker-compose.yml to change image names and improve service health checks.
- Updated README.md and SETUP_THE_PROJECT.md for clearer setup instructions.
- Added database initialization scripts and SQL files for structured database setup.
- Updated frontend Dockerfile to use Node.js 22 and adjusted package.json scripts.
- Improved error handling and logging in start scripts for better debugging.
- Added reCAPTCHA support in the signup page with conditional loading based on environment variables.
This commit is contained in:
chamikaJ
2025-04-18 17:10:56 +05:30
parent 8825b0410a
commit e42819ef64
34 changed files with 948 additions and 376 deletions

View File

@@ -1,6 +1,6 @@
# Worklenz - React Application
# Worklenz - React Frontend
Worklenz is a task management application built with React and bundled using [Vite](https://vitejs.dev/).
Worklenz is a project management application built with React, TypeScript, and Ant Design. The project is bundled using [Vite](https://vitejs.dev/).
## Table of Contents
- [Getting Started](#getting-started)
@@ -15,11 +15,11 @@ To get started with the project, follow these steps:
1. **Clone the repository**:
```bash
git clone https://github.com/Worklenz/worklenz-v2.git
git clone https://github.com/Worklenz/worklenz.git
```
2. **Navigate to the project directory**:
```bash
cd worklenz-v2
cd worklenz/worklenz-frontend
```
3. **Install dependencies**:
```bash
@@ -29,7 +29,7 @@ To get started with the project, follow these steps:
```bash
npm run dev
```
5. Open [http://localhost:3000](http://localhost:3000) in your browser to view the application.
5. Open [http://localhost:5000](http://localhost:5000) in your browser to view the application.
## Available Scripts
@@ -38,7 +38,7 @@ 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.
Open [http://localhost:5000](http://localhost:5000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
@@ -58,7 +58,22 @@ Open [http://localhost:4173](http://localhost:4173) to preview the build.
## Project Structure
The project structure is organized as follows:
The project is organized around a feature-based structure:
```
src/
├── components/ # Reusable UI components
├── hooks/ # Custom React hooks
├── lib/ # Feature-specific logic
├── pages/ # Route components
├── services/ # API services
├── shared/ # Shared utilities, constants, and types
├── store/ # Global state management
├── types/ # TypeScript type definitions
├── utils/ # Utility functions
├── App.tsx # Main application component
└── main.tsx # Application entry point
```
## Contributing
@@ -72,6 +87,9 @@ Contributions are welcome! If you'd like to contribute, please follow these step
## Learn More
To learn more about Vite, check out the [Vite documentation](https://vitejs.dev/guide/).
To learn more about the technologies used in this project:
To learn React, check out the [React documentation](https://reactjs.org/).
- [React Documentation](https://react.dev/)
- [TypeScript Documentation](https://www.typescriptlang.org/docs/)
- [Ant Design Documentation](https://ant.design/docs/react/introduce)
- [Vite Documentation](https://vitejs.dev/guide/)