Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Improve Documentation for PictoPy Setup #81

Merged

Conversation

Rajgupta36
Copy link
Contributor

Pull Request: Enhance PictoPy Setup Documentation and Docker Configuration

Description

This PR enhances the setup documentation and Docker configuration for PictoPy, ensuring clear, easy-to-follow instructions for both backend and frontend components.

Changes

  1. Auto-updated pip in the backend Dockerfile for compatibility.
  2. Exposed port 1420 in the frontend Dockerfile for GUI access.
  3. Added detailed backend and frontend Docker setup documentation.
  4. Updated .dockerignore for optimized builds.
  5. Integrated Docker setup instructions into README.md and index.md.

Documentation Updates

  • Prerequisites and system requirements
  • Repository cloning and Docker image building instructions
  • Running the Docker container
  • Troubleshooting common issues

Checklist

  • Prerequisites and required tools listed
  • Repository cloning instructions provided
  • Docker image building steps documented
  • Container running instructions included
  • Common issues and solutions documented

Additional Notes

  • Port 1420 exposure for frontend may require adjustment based on deployment.
  • Consider adding a section on environment variables if necessary.

For Reviewers

  1. Review Docker setup documentation in README.md and docs/index.md.

Related Issues

Media

Screenshot 2024-11-26 180856
Screenshot 2024-11-26 225903

@Rajgupta36
Copy link
Contributor Author

@Pranav0-0Aggarwal sir , I added all the basic dependencies required for both Linux and Windows to run the Docker application. Additionally, I have made the setup process easier so that beginners can follow along. Kindly review this PR when you have a moment. Thank you!

@Pranav0-0Aggarwal
Copy link
Member

great work @Rajgupta36 and @Jibesh10101011

@Pranav0-0Aggarwal Pranav0-0Aggarwal merged commit 66f86b7 into AOSSIE-Org:main Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Add documentation for running Docker file.
2 participants