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

Add React Frontend #2094

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Conversation

HerrTuring
Copy link

So... I created this web interface using React/Next so that the project can now be hosted and accessed by web browser instead of using the linux terminal.

It has no security features, so it wouldn't be usable for a production environment in its current state, but the use case in my view is actually running in a RPi4 or similar in a closed environment.

The new folder "sherlock-web" has two new Docker images. One is an API made by adding a FastAPI to the original Docker image, and the other is a React frontend. Using the Docker Compose, you get a port 3000 open with the React page and the API only accessible by the React project in itself (without opening a port outside).

I also added a github workflow that does not trigger by itself (must be run manually) to easily publish both images in Dockerhub. So if you want you can publish them yourself (just have to add a username and api key to dockerhub to your github secrets), and if you do that I can simply take my own images offline. I would rather have them updated with the main project anyway.

These are the images that were made for this:

https://hub.docker.com/r/herrturing/sherlock-web
https://hub.docker.com/r/herrturing/sherlock-api

I am not a Python programmer, so I hope the small code I made for this isn't that terrible. :)

@XDark187 XDark187 mentioned this pull request Aug 30, 2024
1 task
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.

2 participants