https://github.com/benmcavoy/jammy

A project jamming competition website
https://github.com/benmcavoy/jammy

design game-jam jam rust software-design surrealdb website

Last synced: 3 days ago
JSON representation

A project jamming competition website

• Host: GitHub
• URL: https://github.com/benmcavoy/jammy
• Owner: BenMcAvoy
• License: mit
• Created: 2024-11-21T00:45:16.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-26T22:09:15.000Z (2 months ago)
• Last Synced: 2024-12-11T02:09:55.909Z (about 2 months ago)
• Topics: design, game-jam, jam, rust, software-design, surrealdb, website
• Language: Rust
• Homepage:
• Size: 108 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  

    

  


  
jammy


  


    A project jamming competition website

    


    

        Visit the website »

    

    


    


    Releases

    ·

    Report Bugs

    ·

    Request Features

  



## What is this?

Imagine a virtual [game jam](https://en.wikipedia.org/wiki/Game_jam) where you have to build a game in a week, now imagine it's for applications, games, websites, and more and it happens every week with a set [theme](https://en.wikipedia.org/wiki/Game_jam#Theme) like clockwork, that's jammy!

## Why?

I'm a software ["jammer"](https://en.wikipedia.org/wiki/Game_jam#History), and I love to "jam", but I also love to build things, so I thought it would be fun to make a jamming competition website that would let people see how they did, and maybe even win prizes.

## Implementation

The backend is wrote in Rust using [Poem](https://github.com/poem-web/poem) (and [Poem OpenAPI](https://github.com/poem-web/poem/tree/master/poem-openapi) for [Swagger](https://swagger.io/)). Frontends are currently a future detail and will be put here when ready.

## Contributing

Contributions are welcome! If you're interested in helping out, please check out the [contributing guidelines](CONTRIBUTING.md).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Building

To build the project, you'll need to have [Rust](https://www.rust-lang.org/) installed. Once you have Rust installed, you can run the following commands to build the project:

```bash

cd backend

cargo build --release

./build/release/jammy

```

Once again, frontends are currently a future detail and will be put here when ready.