The-OAG-Development-Project / Application-Gateway

OWASP Application Gateway is an HTTP proxy that handles Oauth2 authentication and session management
https://owasp.org/www-project-application-gateway/
Apache License 2.0
83 stars 4 forks source link

Create basic website for NellyGateway using VuePress #135

Closed shreyasbhaskarwar closed 9 months ago

shreyasbhaskarwar commented 9 months ago

Created a simple website for the project using VuePress. It currently includes a simple homepage, documentation (taken from Github wiki), and links to a few important resources like the Github repo, OWASP site, and swagger docs. The website gets auto-deployed to github pages using 'gh-pages-deply.yaml' but it needs a github access token to work and some changes to github pages settings of the repository. You can view the website deployed on my fork here.

This is related to #24

Note: I worked on this project as part of a grad course assignment, contributing to an OWASP project. This is my first time contributing to an open-source project, so I apologize if any oversight or mistake occurred on my part.

gianlucafrei commented 9 months ago

This is really cool! Thank you much for contributing.

shreyasbhaskarwar commented 9 months ago

To get the GitHub pages working on your repo, you can follow these steps:

  1. Generate a GitHub Personal Access Token:
  2. Add a Repository Secret:
    • Go to your repository on GitHub.
    • Navigate to Settings > Secrets and variables > Actions > Secrets.
    • Create a new repository secret with the name "ACCESS_TOKEN" and paste the personal access token you generated in Step 1 as the value.
  3. Configure GitHub Pages:
    • Still in your repository settings, go to Settings > Pages.
    • In the "Source" section, select "Deploy from Branch."
    • Set the branch to "gh-pages" and the directory to "/ (root)."

With these settings in place, the website should be successfully deployed to 'https://gianlucafrei.github.io/Application-Gateway/'.