This is the frontend part of the Zuidui project. It is a simple nginx server that serves the static files of the frontend together with the API requests. The API requests are proxied to the backend server and all services are interconnected within a Docker network named zuidui.
Ensure you have the following installed on your system:
app/docker-compose.yml: Defines the services, their configurations, and networking.Dockerfile: Defines the Docker image for the frontend service.nginx.conf: Configuration file for Nginx.public/: Contains static HTML files and assets.src/: Contains the source code for the application..env: Contains environment variables used by Docker Compose and the services. Depending on the environment, you may need to change theCONTEXTvalue tolocal,minikube, oreks.static/: Contains the static files for the application.
Makefile: Provides a set of commands to automate common tasks..githbu/workflows/: Contains the GitHub Actions workflows for CI.
The project uses Makefiles to run the most common tasks:
help: Shows this help.todo: Shows the TODOs in the code.show-env: Shows the environment variables.clean: Cleans the app.build: Builds the app.run: Runs the app.publish-image-pre: Publishes the image to the pre-production registry.publish-image-pro: Publishes the image to the production registry.
- Frontend Application: Accessible at
http://localhost:${APP_PORT}
Contributions are welcome! Please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Commit your changes (
git commit -am 'Add new feature'). - Push to the branch (
git push origin feature-branch). - Open a Pull Request.
This project is licensed under the Apache 2.0 License. See the LICENSE file for details.
For any inquiries or issues, please open an issue on the GitHub repository or contact any of the maintainers.