getnude/clothoff

One-click intelligent dressing system based on AI. Clothoff、Undress、Clothes remover

GetNude

The GetNude library provides convenient access to the GetNude API from applications. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses which makes it compatible with a wide range of versions of the GetNude API.

Requirements

NodeJs 16.15.0 and later.

Document

GetNude API   Official website

clothoff's Issues

Inconsistent HTTP Methods in API Calls

Hello,

I noticed that there are inconsistencies in the HTTP methods used in the API calls.

In the getBalance.js file, the HTTP method is get:

let httpConfig = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://getnude.app/api/mch/balance',
  headers: { 
    'Content-Type': 'application/json'
  },
  data: data
};

However, in the positionGeneration.js file, the method is post for a similar data fetching task:

let httpConfig = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://getnude.app/api/mch/position',
  headers: { 
    'Content-Type': 'application/json'
  },
  data: data
};

To maintain consistency and adhere to RESTful API best practices, could you please review and adjust the HTTP methods accordingly? If getBalance.js is intended to retrieve data, the use of GET is appropriate. Similarly, if positionGeneration.js is also intended to retrieve data, consider whether it should use GET instead of POST.

Expected Behavior

• Consistent use of HTTP methods across different API calls based on the type of operation (retrieval vs. data submission).

Thanks for your attention!

Image generation fails with error code 500

Description:

When attempting to generate an image using the imageGeneration.js script, the request fails with an HTTP 500 error code. This issue prevents the generation of desired images.

Steps to reproduce:

1. Run the imageGeneration.js script with a valid base64 string and merchant credentials.
2. Observe the response, which should return an HTTP 500 error code.

Expected behavior:

The script should successfully generate an image based on the provided base64 string and return a successful response with the generated image URL.

Additional information:

• The base64 string used is valid and has been successfully used in previous requests.
• The merchant credentials are correct and have been verified.
• The Node.js version used is compatible with the GetNude library.

Possible causes:

• Server-side error on the GetNude API.
• Incorrect configuration of the imageGeneration.js script.
• Network connectivity issues.

Request:

• Investigate the cause of the HTTP 500 error code.
• Provide a solution to resolve the issue and enable successful image generation.
• If the issue is related to the GetNude API, please provide an estimated timeframe for resolution.

Additional notes:

• I have reviewed the GetNude documentation and confirmed that the script is configured correctly.
• I have verified that the base64 string and merchant credentials are valid.
• I have checked my network connectivity and confirmed that it is stable.

Thank you for your time and assistance in resolving this issue.

Multiple Issues Encountered with Demo and API Usage

Description

I've been experimenting with the GetNude library and encountered several issues that I'm hoping to get some assistance with. My primary concerns involve receiving unsatisfactory results from the API, creating DeepNude photos, handling request timeouts, and dealing with a build error when running the demo. These issues are detailed below:

1. Unsatisfactory Result Handling: Upon using the API, there have been instances where the results did not meet expectations. Is there a recommended approach for handling or improving unsatisfactory results?

2. Creating DeepNude Photos: I am interested in understanding the correct process for creating DeepNude photos using this library. Could you provide a step-by-step guide or reference documentation that elaborates on this process?

3. Request Timeout on img-2-img API Call: When attempting to use the img-2-img API endpoint, the request times out occasionally without returning a response. What steps can be taken to mitigate this issue, and is there a way to adjust the timeout settings?

4. Build Error When Running Demo: While trying to run the demo provided in the NodeJs folder, I encountered a build error that prevents the demo from executing properly. The error message is not very descriptive. Could you provide some guidance on how to resolve this?

Steps to Reproduce (for build error)

1. Clone the repository.
2. Navigate to the NodeJs/Demo directory.
3. Run npm install to install dependencies.
4. Execute the demo script using node <demo_script_name>.js.
5. Encounter the build error.

I would greatly appreciate any help or guidance on these issues. Thank you for your time and support.

Environment

• NodeJs Version: 16.15.0
• OS: Ubuntu 22.04

Inconsistent Node.js Version Requirements in README

The README file specifies that Node.js 16.15.0 and later is required, but it's unclear if this is the minimum version required for the entire project or just for the GetNude library.

The project should clearly specify the minimum Node.js version required for the entire project, and provide instructions for installing and running the project with the correct version. But the README file only specifies the version requirement for the GetNude library, leaving ambiguity about the project's overall version requirements.

Please update the README file to clearly specify the minimum Node.js version required for the entire project, and provide instructions for installing and running the project with the correct version.

This issue is important because it may cause confusion for users who are trying to install and run the project, and may lead to errors or incompatibility issues if the incorrect Node.js version is used.

Add Contributing Guidelines to Documentation

I've recently discovered the Clothoff project and I'm excited to explore its potential. While going through the repository, I noticed that there is no clear guidance on how to contribute to the project.

As an experienced GitHub user, I understand that having a clear and concise contributing guide helps attract new contributors and ensures that their contributions align with the project's goals and standards.

To improve the project's accessibility to potential contributors, I suggest adding a CONTRIBUTING.md file in the project's root directory. Here's a brief outline of what the file might include:

1. Code of Conduct: Clearly state the project's expectations for behavior and participation.
2. Issue Reporting: Explain how to report issues, including best practices and required information.
3. Feature Requests: Outline how to submit feature requests or enhancements.
4. Pull Requests: Provide guidelines for submitting pull requests, such as coding style, testing, and documentation.
5. Branches and Merging: Explain the branching strategy and the merge process.
6. Communication: Include contact information for the maintainers and describe the preferred communication channels.

By following these guidelines, you can create a welcoming and engaging environment for new contributors. I'm happy to help or contribute to the creation of this document if needed.

Thank you for your time and consideration.

Best regards,

---

By the way, I've already created a simple template for the CONTRIBUTING.md file based on the outline provided above. You can use this template as a starting point to create a more detailed and customized document for this project:

# Contributing to Clothoff

Thanks for your interest in contributing to Clothoff! We welcome all contributions, including bug reports, feature requests, documentation updates, and code improvements.

## Code of Conduct

Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).

## Issue Reporting

If you find an issue, please [search open issues](https://github.com/GetNude/Clothoff/issues) before submitting a new one. When filing a new issue, please provide the following information:

- Version of Clothoff
- Description of the issue
- Steps to reproduce the issue
- Expected outcome
- Actual outcome
- Any relevant logs, screenshots, or error messages

## Feature Requests

If you have an idea for a new feature, please [open an issue](https://github.com/GetNude/Clothoff/issues/new) and describe the proposed feature, explain why it would be beneficial, and provide any relevant context.

## Pull Requests

To submit a pull request, please follow these steps:

1. Fork the repository
2. Create a new branch for your changes
3. Make your changes, ensuring they follow the project's coding style and best practices
4. Write tests to cover your changes
5. Run the tests and ensure they pass
6. Commit your changes
7. Push your changes to your forked repository
8. [Open a pull request](https://github.com/GetNude/Clothoff/compare)

Please ensure that your pull request includes the following:

- A clear description of the changes
- Relevant screenshots or documentation
- Any necessary updates to the documentation
- Test coverage for your changes

## Branches and Merging

We use the following branching strategy:

- `main`: The main branch, containing the latest stable release
- `develop`: A development branch, where new features and bug fixes are merged
- Feature branches: Branches created for specific features or bug fixes

When a pull request is approved, it will be merged into the `develop` branch and then merged into the `main` branch for the next release.

## Communication

For general questions or discussions, please use the [Clothoff discussion forum](https://github.com/GetNude/Clothoff/discussions).

If you have specific questions or need help with your contribution, please [contact the maintainers](mailto:[email protected]).

Thank you for contributing to Clothoff!

This template is intended to be a starting point, and you can modify and expand it to fit your project's needs. It's essential to have a clear and concise contributing guide to help new contributors understand how to contribute and make their efforts more impactful.

I hope this helps!