How to Contribute

Step 1: Choose a issue

Choose a issue from this list to get started

Step 2: Dev Environment Setup

Fork the repository from Resseract Lite

Server Setup

1. Go to server/Resseract
2. Set env variable RESSERACT_PROFILE to local

// Windows
set "RESSERACT_PROFILE=local"

// Linux
export RESSERACT_PROFILE=local

3. Run the maven app mvn spring-boot:run

Server should be running on http://localhost:8242/api. You can test the same using health api http://localhost:8242/api/health

Angular App Setup

1. Go to angular-app/Resseract
2. Run npm install
3. Run ng serve --host 0.0.0.0 --proxy-config local-proxy.config.json to run UI component of the app

Angular app should be running on http://localhost:4200/canvas

Please use http://localhost:4200/canvas for development. DO NOT USE http://localhost:8242/canvas

Step 3: Raise Pull Request

• Make required changes
• Commit changes. Please use this template Issue #<ISSUE_NUMBER> | <COMMIT MESSAGE>
• Raise pull request

If you face any problem, please create a issue