Swaggy UI

Overview

Swaggy UI is a javascript project intended for use in single-page applications that to enhance the user interface of the Swaggy-Swagger library. Swaggy-Swagger builds upon the popular Swagger framework, providing a more intuitive and flexible API documentation experience.

See Swaggy-Swagger README.md for more details.

Demo Video

Swaggy UI is a customized version of Swagger UI. It is derived from the original Swagger UI open-source project, which has been cloned, modified, and built upon to create a more tailored user interface experience. For more details about the original Swagger UI project, see the Swagger UI.

Ways to contribute

If you want to contribute our java library directly, please refer to this link for more details.

Swaggy UI is an open-source project. We welcome contributions! Visit our GitHub repository to submit a pull request.

1. To avoid duplicating works, please check GitHub Pull Requests for any existing open or closed PRs related to your submission before you start.

2. Fork this repository to your GitHub: click to fork swaggy-ui

3. Clone the Repository: Start by cloning the Swaggy-UI repository to your local machine.

   git clone <https://github.com/{your-github-id}/swaggy-ui.git>
   cd swaggy-ui
   

4. Install Dependencies: Navigate to the project directory and install the necessary dependencies.

   npm install
   

5. Make Changes to the UI: Modify the UI as needed to fit your requirements.

6. Build the Project: After making changes, build the project to generate the updated version of Swaggy-Swagger UI.

   npm run build
   

   This command will create or update the dist folder with the built files.

7. Push the Changes: Push your changes to your forked repository. Make sure to follow our style guide for commit messages. The build files in the dist folder will be automatically pushed to the Swagger-custom Java library repository through GitHub Actions.

   git add .
   git commit -m "style: Update components and rebuild"
   git push origin main
   

   Note: Follow our commit message STYLE GUIDE for the format of the commit messages. This is simply a recommendation, so feel free to contribute in the way you find best!

8. Automated Deployment: Once changes are pushed, GitHub Actions will automatically handle the deployment by pushing the updated dist folder to the relevant Java library repository.

9. Contributing: If you'd like to contribute your changes back to the Swaggy-Swagger UI repository, feel free to submit a pull request.

Contributors

Thank you to everyone who contributed to our project.

Made with contrib.rocks

Contact