Giter VIP home page Giter VIP logo

gjms's Introduction

v0.4.5 - Bringing game jam hosting to everyone!

alt text

The vision

Today more and more game jams are being hosted. But hosting game jams is hard.
You have to write your own submission forms, backend code and all other management.
After having hosted 3 game jams myself, I know how tedious this is.

The Game Jam Management System tries to change the status quo, by doing the heavy lifting for you. It aims to provide a fully-featured backend for managing game jams, while allowing you to retain full control over what happens at the front.

The ultimate version of GJMS is easy to setup, easy to use, yet very powerful.
In short: Game jam hosting for everyone!

Getting started

GJMS is implemented in Python. Thus, you need access to Python and pip to run it.
The ideal setup for GJMS is an Apache server with mod_rewrite activated.
Linux preferred. I won't stop you from running it on Windows, though.

These are the things you need to do:

  • Clone the repository to your web server: git clone git://github.com/Folis/gjms.git
  • Go to the path of the repo: cd path/to/gjms
  • Resolve dependencies: pip install -r project/requirements.txt
  • Setup a proxy to localhost on port 8196 via .htaccess:
    RewriteEngine On
    RewriteRule ^(.*)$ http://127.0.0.1:8196/path/to/gjms/$1 [P]

  • Start GJMS with the included Twisted WSGI server: twistd -n web --port 8196 --wsgi gjms.app

You should be greeted by a little intro text and some server output telling you that it created an instance of itself. After you set up your proxy, go to your-website.com/gjms-config/, which will guide you through a setup process to get all necessary data. After finishing the setup process you are ready to go!

Contributing

Contributions to GJMS are always welcome, however there are a few guidelines to the
process to keep the project organised. These are:

Formatting

  • Code close to PEP-8 standards. (PyLint is very helpful here.)
  • Only use spaces for indentation
  • Semi-colons are discouraged

Branching and git management

  • Updates/commits before version 1.0 go to master. After we will go by the git flow model:
    • The master branch should be production ready at all times.
    • develop is for all features included in the next release.
    • Adding a new feature? Start a branch: feature/gjms-[module]-[submodule]
      (for gjms.core.users this would be feature/gjms-core-users.)
      Also be sure to write unit tests and check against exisiting tests (see test/test.py).

General

  • Set up a virtualenv to avoid unwanted dependencies.
  • Pull requests should get reviewed within 12/24 hours. (Usuall at 1 p.m. or 10 p.m. CET.)
  • Issues will be ultimately closed by Folis (Richard Blechinger).

License

The Game Jam Management System is licensed under a BSD 3-clause license.
Refer to the LICENSE file for detailed information.

gjms's People

Contributors

madpew avatar

Watchers

James Cloos avatar Sven Anders Robbestad avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.