/web

winget.run web frontend

Primary LanguageTypeScript

Winget.run React App

The frontend to winget.run, allowing users to search, discover, and install winget packages effortlessly without any third-party programs. Package manifests are periodically fetched from the GitHub API to prevent hitting ratelimits.

If you wish to use our API, please take a look at our docs. All other non-documentation info will be provided in this readme.

Contents

Installation

A Docker image is built for the project in our CI/CD pipeline on the develop, release/* and master branches. These can be found here. A detailed example of building and running the project without docker can be found in the development section.

Development

Local development requires the following software:

  • NodeJS
  • Yarn

If everything is set up correctly, run the following command for an optimal development environment, which will make Next.js watch for changes and statefully hot-reload.

  • yarn dev - To use the development API
  • yarn dev:prod - To use the production API

Tests and linting can be run using the following commands:

  • yarn test
  • yarn lint

To create and serve a production-ready bundle, run:

  • yarn build
  • yarn serve

For any additional commands, check out the package.json.

Deployment

We use GitHub Actions CI/CD and Kubernetes for our deployments. All required into regarding deployments can be found in /.github and /chart.

Contributing

Issues and pull requests are welcome. We currently don't have any templates (at the time of writing) so a pr for those would be nice as well. If you wish to check the progress of current tickets, we have boards set up using ZenHub.

We currently don't have tests, but will add them soon™.

Authors

  • Matthew Watt (MattheousDT)
  • Lukasz Niezabitowski (Dragon1320)
  • Ryan Larkin (rlarkin212)

Acknowledgments

  • Myself, for not ending it sooner. I'm proud of myself.

License

Ask us if you want to use the code, or suggest a license and make a pr.