https://github.com/godotengine/godot-prs-by-file

https://github.com/godotengine/godot-prs-by-file

godot godot-engine godotengine production triage

Last synced: about 11 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/godotengine/godot-prs-by-file
• Owner: godotengine
• License: mit
• Created: 2023-03-04T18:58:53.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T09:30:39.000Z (3 months ago)
• Last Synced: 2024-10-29T09:31:44.860Z (3 months ago)
• Topics: godot, godot-engine, godotengine, production, triage
• Language: JavaScript
• Homepage: https://godotengine.github.io/godot-prs-by-file/
• Size: 103 KB
• Stars: 17
• Watchers: 7
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Godot PRs by File

This project is provided for Godot Engine contributors to quickly find open

PRs editing a specific file or folder. With the amount of work that goes into

Godot it becomes tricky to keep in mind every PR that touches every file, and

identify conflicts or duplicates. This project aims to help with that.

Live website: https://godotengine.github.io/godot-prs-by-file/

## Contributing

This project is written in JavaScript and is built using Node.JS. HTML and CSS are

used for the presentation. The end result of the build process is completely static

and can be server from any web server, no Node.JS required.

Front-end is designed in a reactive manner using industry standard Web Components

(powered by `lit-element`). This provides native browser support, and results in a

small overhead from the build process.

To build the project locally you need to have Node.JS installed (12.x and newer

should work just fine).

This project uses GitHub's GraphQL API. To fetch live data you need to generate

a [personal OAuth token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).

You can supply your token to the scripts using the `GRAPHQL_TOKEN` environment

variable. Note, that if you don't have member access to the organization, you

may not be able to access all the information used when generating the database.

1. Clone or download the project.

2. From the project root run `npm install` or `yarn` to install dependencies.

3. Run `npm run build` or `yarn run build` to build the pages.

4. Run `npm run compose-db` or `yarn run compose-db` to fetch the data from GitHub.

5. Serve the `out/` folder with your method of choice (e.g. using Python 3:

   `python -m http.server 8080 -d ./out`).

`rollup` is used for browser packing of scripts and copying of static assets. The

data fetching script is plain JavaScript with `node-fetch` used to polyfill

`fetch()`-like API.

## License

This project is provided under the [MIT License](LICENSE.md).