{"id":19525450,"url":"https://github.com/artur24814/clearframe","last_synced_at":"2026-04-14T04:02:36.560Z","repository":{"id":259204221,"uuid":"874652911","full_name":"artur24814/ClearFrame","owner":"artur24814","description":"Suggests removing background or editing images, while emphasizing clarity","archived":false,"fork":false,"pushed_at":"2024-11-18T07:58:34.000Z","size":1308,"stargazers_count":1,"open_issues_count":8,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-26T01:43:33.726Z","etag":null,"topics":["image-processing","jwt-authentication","opencv","react","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/artur24814.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-18T08:10:31.000Z","updated_at":"2024-11-18T07:58:38.000Z","dependencies_parsed_at":"2024-11-09T11:19:52.733Z","dependency_job_id":"8b1bb762-c1d2-48cd-bce3-5f13c2cd9d41","html_url":"https://github.com/artur24814/ClearFrame","commit_stats":null,"previous_names":["artur24814/clearframe"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/artur24814/ClearFrame","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artur24814%2FClearFrame","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artur24814%2FClearFrame/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artur24814%2FClearFrame/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artur24814%2FClearFrame/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/artur24814","download_url":"https://codeload.github.com/artur24814/ClearFrame/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artur24814%2FClearFrame/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266235370,"owners_count":23897176,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["image-processing","jwt-authentication","opencv","react","spring-boot"],"created_at":"2024-11-11T01:04:30.893Z","updated_at":"2026-04-14T04:02:36.520Z","avatar_url":"https://github.com/artur24814.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ClearFrame\n### Image Processing Application\n\nThis application offers advanced image editing capabilities, specializing in removing backgrounds and enhancing photo elements to create polished, professional images. Ideal for personal, marketing, and e-commerce needs, it combines machine learning techniques with customizable editing tools to streamline image enhancement processes. \n\n## Features\n- **Background Removal**: Seamlessly remove backgrounds from images with precision.\n- **Image Enhancement**: Edit image elements like colors, shadows, and contrast.\n- **User Authentication**: Secure login and registration using JWT-based authentication.\n\n## Tech Stack\n- **Backend**: Java with Spring Boot\n  - Dependencies:\n    - `spring-boot-starter-data-jpa`\n    - `spring-boot-starter-web`\n    - `spring-boot-starter-security`\n    - `h2database`\n    - `openCv`\n    - `jjwt-api`, `jjwt-impl`, and `jjwt-jackson` for JWT handling\n- **Frontend**: React\n  - Main Libraries: `axios`, `react-router-dom`, `react-bootstrap`, `react-hook-form`, `yup`\n\n## Installation\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/your-username/your-repository.git\n\n2. Backend Setup:\n    - Navigate to the `backend` directory.\n    - Build and run the Spring Boot application:\n        ```bash\n        mvn spring-boot:run \n        ```\n3. Frontend Setup:\n    - Navigate to the `frontend` directory.\n    - Install dependencies and start the application:\n        ```bash\n        npm install\n        npm start\n        ```\n\n## API Documentation\n\u003cdetails\u003e \u003csummary\u003eAPI Endpoints\u003c/summary\u003e\n\n### Authentication Endpoints\n##### Login\nEndpoint: `POST /api/auth/login`\n\nAuthenticates a user by email and password, returning a JSON Web Token (JWT) on success.\n\n- Request Body:\n    ```json\n    {\n    \"email\": \"user@example.com\",\n    \"password\": \"securePassword\"\n    }\n    ```\n- Response:\n    - 200 OK: Returns a JSON object with the user's email and JWT token:\n        ```json\n        {\n        \"user\": \"user@example.com\",\n        \"token\": \"jwt-token\"\n        }\n        ```\n    - 401 Unauthorized: Authentication failed.\n\n#### Register\nEndpoint: `POST /api/auth/register`\n\nCreates a new user profile.\n\n- Request Body:\n    ```json\n    {\n    \"firstName\": \"John\",\n    \"secondName\": \"Doe\",\n    \"email\": \"john.doe@example.com\",\n    \"password\": \"newSecurePassword\",\n    \"permissions\": \"user\"\n    }\n    ```\n- Response:\n    - 201 Created: `\"User registered successfully\"`\n    - 400 Bad Request: Returns an error message if registration fails.\n\n### Background Removal\nEndpoint: `POST /api/bg-remove/process`\n\nProcesses an uploaded image by removing its background and returns the modified image in PNG format.\n\n- Request Parameters:\n    `file` (required): An image file in `multipart/form-data` format to be processed.\n- Example Request:\n    ```bash\n    curl -X POST http://localhost:8080/api/bg-remove/process \\\n        -H \"Content-Type: multipart/form-data\" \\\n        -F \"file=@/path/to/image.png\"\n    ```\n- Response:\n    - 200 OK: Returns the processed image with the background removed in image/png format.\n    - 400 Bad Request: Returns if the uploaded file is empty or missing.\n\u003c/details\u003e\n\n## License\nThis project is licensed under the MIT License.\n\n## Developers\nContributions are welcome! Please follow the contribution guidelines and open a pull request.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartur24814%2Fclearframe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartur24814%2Fclearframe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartur24814%2Fclearframe/lists"}