Skip to content

Interactiondesigner/sportchef

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SportChef

Build Status Coverage Status Codacy Badge Dependency Status Dependency Status
Stories in Ready Issue Stats Issue Stats Join the chat at https://gitter.im/McPringle/sportchef

Sports Competition Management Software with a modern and fast architecture. Java based backend with a RESTful JSON API and a HTML 5 client with a modern UI.

Copyright (C) 2015 Marcus Fihlon

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Technology

Server

The saver is base on Java EE technology and provides high-performance, RESTful web services. Everything is tied together using a Maven build.

Client

For the client we decided wo go with HTML5 and Google Polymer.

Website

We'll use GitHub Pages for hosting our upcoming project website. We only need static content, so we decided to go with Hugo, a fast and modern static website engine. Our content will be written in Markdown syntax.

Tools

We use a Maven build to tie everything together. As a result this project is IDE independent (every state-of-the-art IDE should be able to import and/or use a Maven project). VersionEye is used to track out of date dependencies. To track our reaction time on issues and pull requests we use Issue Stats.

How to contribute to SportChef

Contributors

A huge thank you to all the contributors! All contributors are listed below (sorted alphabetically by GitHub username):

If you are a contributor and you are missing on this list, please add your entry yourself and create a pull request or create an issue.

Milestones

Version Planned Release Date Status
v1.0 End of January 2016 released
v1.1 End of February 2016 work in progress
v1.2 End of March 2016
v2.0 End of April 2016
v2.1 End of May 2016
v2.2 End of June 2016
v3.0 End of July 2016
v3.1 End of August 2016
v3.2 End of September 2016
v4.0 End of October 2016
v4.1 End of November 2016
v4.2 End of December 2016

Source code management

GIT Workflow Rules

We use the GitFlow workflow for SportChef. You can read a really good explanation of GitFlow on the Blog of Vincent Driessen: A successful Git branching model

GitFlow Workflow Visualization by Seibert Media

Keep your fork in sync

If you fork this repository, GitHub will not keep your fork in sync with this repository. You have to do it on your own.

  1. If not already done, add this repository as an upstream to your repository:
    git remote add upstream https://github.com/McPringle/sportchef.git
  2. Verify that this repository was added successfully:
    git remote -v
  3. Fetch branches and commits from this repository to your local repository:
    git fetch upstream
  4. If you are not on your local develop branch, check it out:
    git checkout develop
  5. Merge the changes from this repositories develop branch into your repository):
    git merge upstream/develop
  6. Push your updated repository to your GitHub fork:
    git push origin develop

If you want to merge changes from a different branch (e.g. master, release, etc), simply replace the branch name develop in the above command line examples with the branch name, you want to merge.

Frequently Asked Questions

  1. When I try to push, I get a non-fast-forward updates were rejected error.
    Your local copy of a repository is out of sync with, or behind the upstream repository, you are pushing to. You must retrieve the upstream changes, before you are able to push your local changes.

About

Sports Competition Management Software

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 74.5%
  • HTML 22.7%
  • CSS 2.8%