Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 3.22 KB

README.md

File metadata and controls

44 lines (27 loc) · 3.22 KB
Raw

Pygame: Community Edition Website

prs: welcome license lint status website status docs status code style: prettier code style: black

About

The official website representing Pygame: Community Edition utilizing NextJS, ReactJS, and TypeScript. We are currently using GitHub Pages to deploy our website, which might change in the future if we decide to add a database to store user projects.

Frequently Asked Questions

  1. Why the fancy tech stack?

In the future, this will not be just a fancy static website, we will be adding blog and user project showcase support and NextJS would be a big help in making it happen while Tailwind CSS would allow us to add CSS easier.

  1. Can I add my game to the website?

Maybe! We currently do not have an official way to request for your game to be featured, but for now just message us through Discord. If your game impresses us, we will add it to the site's homepage.

  1. Why is the domain pyga.me instead of pygame.org

pygame.org is not associated with the Pygame Community.

Contributing

Pull requests from outside the core development team are welcome, check out the good-first-issue tag. Before you create a pull request, please create an issue using our issue tracker to avoid any work efforts being lost.

Limitations to Outside Contributors

We welcome all outside contributors to help out on building our website, but there are some limitations if you are not a core member of the development team.

  1. Your pull request must have a low impact
  2. You cannot make a complete redesign of a website page
  3. New design choices are decided by the core development team

Instructions to Build

  1. Install Visual Studio Code
  2. Install the Python and Prettier extensions for Visual Studio Code
  3. Install NodeJS
  4. Run npm install to install all dependencies
  5. Run npm run dev to create a local server to start contributing!
  6. Open http://localhost:3000 to view your changes
  7. Before pushing a commit, please run npx prettier --write . and black ., although Visual Studio Code should automatically perform this task for you