Files

chamikaJ e42819ef64 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.

2025-04-18 17:10:56 +05:30

2.8 KiB

Raw Blame History

Worklenz Backend

This is the Express.js backend for the Worklenz project management application.

Getting Started

Follow these steps to set up the backend for development:

Configure Environment Variables:
- Create a copy of the .env.example file and name it .env.
- Update the required fields in .env with your specific configuration.

Set up Database:

Create a new database named worklenz_db on your local PostgreSQL server.
Update the database connection details in your .env file.
Execute the SQL setup files in the correct order:

# From your PostgreSQL client or command line
psql -U your_username -d worklenz_db -f database/sql/0_extensions.sql
psql -U your_username -d worklenz_db -f database/sql/1_tables.sql
psql -U your_username -d worklenz_db -f database/sql/indexes.sql
psql -U your_username -d worklenz_db -f database/sql/4_functions.sql
psql -U your_username -d worklenz_db -f database/sql/triggers.sql
psql -U your_username -d worklenz_db -f database/sql/3_views.sql
psql -U your_username -d worklenz_db -f database/sql/2_dml.sql
psql -U your_username -d worklenz_db -f database/sql/5_database_user.sql

Alternatively, you can use the provided shell script:

# Make sure the script is executable
chmod +x database/00-init-db.sh
# Run the script (may need modifications for local execution)
./database/00-init-db.sh

Install Dependencies:
```
npm install
```
Run the Development Server:
```
npm run dev
```
This starts the development server with hot reloading enabled.
Build for Production:
```
npm run build
```
This will compile the TypeScript code into JavaScript for production use.
Start Production Server:
```
npm start
```

API Documentation

The API endpoints are organized into logical controllers and follow RESTful design principles. The main API routes are prefixed with /api/v1.

Authentication

Authentication is handled via JWT tokens. Protected routes require a valid token in the Authorization header.

File Storage

The application supports both S3-compatible storage and Azure Blob Storage for file uploads. Configure your preferred storage option in the .env file.

Development Guidelines

Code should be written in TypeScript
Follow the established patterns for controllers, services, and middlewares
Add proper error handling for all API endpoints
Write unit tests for critical functionality
Document API endpoints with clear descriptions and examples

Running Tests

npm test

Docker Support

The backend can be run in a Docker container. See the main project README for Docker setup instructions.

2.8 KiB Raw Blame History