Skip to content
This repository has been archived by the owner on Feb 26, 2020. It is now read-only.

Commit

Permalink
Merge branch 'release/v1.0.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
McPringle committed Feb 6, 2016
2 parents bf82166 + 395656c commit 060ae0f
Show file tree
Hide file tree
Showing 67 changed files with 4,755 additions and 9 deletions.
3 changes: 3 additions & 0 deletions .bowerrc
@@ -0,0 +1,3 @@
{
"directory" : "src/main/webapp/bower_components"
}
5 changes: 5 additions & 0 deletions .gitignore
Expand Up @@ -8,3 +8,8 @@ doc/sportchef_technical_documentation.lot
doc/sportchef_technical_documentation.out
doc/sportchef_technical_documentation.synctex.gz
doc/sportchef_technical_documentation.toc
src/main/resources/cfg_custom.properties
src/main/resources/rebel.xml
src/main/webapp/bower_components
src/main/webapp/imprint.md
nb-configuration.xml
661 changes: 661 additions & 0 deletions LICENSE.md

Large diffs are not rendered by default.

76 changes: 76 additions & 0 deletions README.md
@@ -0,0 +1,76 @@
*SportChef*
======

[![Dependency Status](https://www.versioneye.com/user/projects/562e699c36d0ab001600160c/badge.svg?style=flat)](https://www.versioneye.com/user/projects/562e699c36d0ab001600160c) [![Dependency Status](https://www.versioneye.com/user/projects/562e699636d0ab00210013b8/badge.svg?style=flat)](https://www.versioneye.com/user/projects/562e699636d0ab00210013b8) [![Issue Stats](http://issuestats.com/github/McPringle/sportchef/badge/issue)](http://issuestats.com/github/McPringle/sportchef) [![Issue Stats](http://issuestats.com/github/McPringle/sportchef/badge/pr)](http://issuestats.com/github/McPringle/sportchef) [![Join the chat at https://gitter.im/McPringle/sportchef](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/McPringle/sportchef?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

**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](https://maven.apache.org/) build.

## Client

For the client we decided wo go with [HTML5](http://www.w3.org/TR/html5/) and [Google Polymer](https://www.polymer-project.org/).

## Website

We'll use [GitHub Pages](https://pages.github.com/) for hosting our upcoming project website. We only need static content, so we decided to go with [Hugo](http://gohugo.io/), a fast and modern static website engine. Our content will be written in [Markdown](http://en.wikipedia.org/wiki/Markdown) syntax.

## Tools

We use a [Maven](https://maven.apache.org/) 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](https://www.versioneye.com/user/projects/55715899626264001e000000) is used to track out of date dependencies. To track our reaction time on issues and pull requests we use [Issue Stats](http://issuestats.com/github/McPringle/sportchef).

# How to contribute to *SportChef*

## 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](http://nvie.com/): [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/)

![GitFlow Workflow Visualization by Seibert Media](https://blog.seibert-media.net/wp-content/uploads/2014/03/Gitflow-Workflow-4.png)

### 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:<br/>`git remote add upstream https://github.com/McPringle/sportchef.git`
2. Verify that this repository was added successfully:<br/>`git remote -v`
3. Fetch branches and commits from this repository to your local repository:<br/>`git fetch upstream`
4. If you are not on your local develop branch, check it out:<br/>`git checkout develop`
5. Merge the changes from this repositories develop branch into your repository):<br/>`git merge upstream/develop`
7. Push your updated repository to your GitHub fork:<br/>`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.<br/>*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.*
28 changes: 28 additions & 0 deletions bower.json
@@ -0,0 +1,28 @@
{
"name": "SportChef",
"homepage": "https://github.com/McPringle/sportchef",
"description": "Sports Competition Management Software",
"main": "",
"moduleType": [],
"private": true,
"license": "AGPL",
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"src/main/webapp",
"test",
"tests"
],
"dependencies": {
"polymer": "Polymer/polymer#~1.2.4",
"paper-elements": "PolymerElements/paper-elements#~1.0.7",
"iron-ajax": "PolymerElements/iron-ajax#~1.0.7",
"iron-form": "PolymerElements/iron-form#~1.0.11",
"iron-icons": "PolymerElements/iron-icons#~1.0.5",
"iron-icon": "PolymerElements/iron-icon#~1.0.7",
"file-upload": "~1.6.3",
"jquery": "~2.2.0",
"marked-element": "PolymerElements/marked-element#^1.x.x"
}
}
Binary file added doc/sportchef_technical_documentation.pdf
Binary file not shown.

0 comments on commit 060ae0f

Please sign in to comment.