Skip to content

Commit

Permalink
git init
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebazzz committed Mar 14, 2020
0 parents commit 04b16e1
Show file tree
Hide file tree
Showing 6 changed files with 508 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
build.sh text eol=lf
build.cake text eol=lf
184 changes: 184 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.

# User-specific files
*.suo
*.user
*.sln.docstates
.vs
.dotnet
tools/*
project.lock.json

# Build results
artifacts
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
x64/
build/
bld/
[Bb]in/
[Oo]bj/

# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*

#NUNIT
*.VisualState.xml
TestResult.xml

# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c

*_i.c
*_p.c
*_i.h
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc

# Chutzpah Test files
_Chutzpah*

# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opensdf
*.sdf
*.cachefile

# Visual Studio profiler
*.psess
*.vsp
*.vspx

# TFS 2012 Local Workspace
$tf/

# Guidance Automation Toolkit
*.gpState

# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user

# JustCode is a .NET coding addin-in
.JustCode

# TeamCity is a build add-in
_TeamCity*

# DotCover is a Code Coverage Tool
*.dotCover

# NCrunch
*.ncrunch*
_NCrunch_*
.*crunch*.local.xml

# MightyMoose
*.mm.*
AutoTest.Net/

# Web workbench (sass)
.sass-cache/

# Installshield output folder
[Ee]xpress/

# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html

# Click-Once directory
publish/

# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml

# NuGet Packages Directory
packages/
## TODO: If the tool you use requires repositories.config uncomment the next line
#!packages/repositories.config

# Enable "build/" folder in the NuGet Packages folder since NuGet packages use it for MSBuild targets
# This line needs to be after the ignore of the build folder (and the packages folder if the line above has been uncommented)
!packages/build/

# Bower
bower_components/

# Windows Azure Build Output
csx/
*.build.csdef

# Windows Store app package directory
AppPackages/

# Others
sql/
*.Cache
ClientBin/
[Ss]tyle[Cc]op.*
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.pfx
*.publishsettings
node_modules/

# RIA/Silverlight projects
Generated_Code/

# Backup & report files from converting an old project file to a newer
# Visual Studio version. Backup files are not needed, because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm

# SQL Server files
*.mdf
*.ldf

# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings

# Microsoft Fakes
FakesAssemblies/
/src/App/stats.json
*.db
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# ![Icon](doc/logo.png) PokerTime

Remote planning poker tool built in ASP.NET Core and Blazor

Licensed: GNU GPL v3.0

[![Build status](https://ci.appveyor.com/api/projects/status/7bjrmgtek7j080d7?svg=true)](https://ci.appveyor.com/project/Sebazzz/PokerTime)
[![CircleCI](https://circleci.com/gh/Sebazzz/PokerTime.svg?style=svg)](https://circleci.com/gh/Sebazzz/PokerTime)
[![Github CI](https://github.com/sebazzz/PokerTime/workflows/Continuous%20integration/badge.svg)](https://github.com/Sebazzz/PokerTime/actions?workflow=Continuous+integration)

## Features

- Realtime retrospective app, ideal for remote teams
- Shortcut support:
- Ctrl + lane number for adding notes or groups
- Ctrl + delete for deleting focused note
- Create password protected retrospectives
- As facilitator, lead the retrospective through the writing, grouping and voting phase.
- Overview with highest voted items

### Browser Support

Developed and tested on:

- Internet Explorer 11
- Microsoft Edge
- Google Chrome
- Mozilla Firefox

## Download

Download the release for your OS from the [releases tab](https://github.com/Sebazzz/PokerTime/releases) or download the cutting edge builds from [AppVeyor](https://ci.appveyor.com/project/Sebazzz/PokerTime).

[Follow the installation instructions](docs/Installation.md) in the documentation to install it.

## Building PokerTime from sources

If you prefer to build the application yourself, please follow the [compilation instructions](doc/Building-from-sources.md) in the documentation.

## Screenshots

*to-do*

## Contributions

Contributions are allowed and encouraged. In general the rules are: same code style (simply use the included `.editorconfig`), and write automated tests for the changes.

Please submit an issue to communicate in advance to prevent disappointments.

## Attribution

Application icon:

- Icon made by [Eucalyp](https://www.flaticon.com/authors/eucalyp) from [www.flaticon.com](http://www.flaticon.com/)

Built on:

- [Bulma](https://bulma.io) _CSS framework_;
- [Fontawesome](http://fontawesome.io/) as _icon framework_;
- [ASP.NET Core 3.1](https://dot.net) (Blazor Server) with [Entity Framework Core](https://docs.microsoft.com/en-us/ef/core/) for _server side logic and data persistence_;
73 changes: 73 additions & 0 deletions doc/Building-from-sources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Building PokerTime from sources

If you like to build PokerTime from sources, you can follow the instructions below.

## Prequisites

- [.NET Core 3.1 SDK](https://www.microsoft.com/net/download/core).
- [Node.js LTS](https://nodejs.org/en/download/) or higher (Node.js 10.x is supported too).
- [Yarn](https://yarnpkg.com/en/docs/install) or higher

### Additional prequisites on Windows

- Windows Powershell or Powershell 7

### Additional prequisites on Linux (Ubuntu)

Environment:

- Ensure `yarn` and `node` are in your `PATH`.
- Ensure `dotnet` is in your `PATH`.

For running the build script:

- Ensure the Powershell execution policy is set to [**RemoteSigned**](https://technet.microsoft.com/en-us/library/ee176961.aspx).

## Check-out

Pull the sources from this repository's [home page](https://github.com/Sebazzz/PokerTime).

## Building

Use the build script in the root to build the application:

build

To create a deployment to one of the supported platforms:

build -Target Publish

The results will be emitted in the `build/publish` folder. For additional supported command line parameters run:

build -h

## Development

After you've build the application once you can start developing.

To develop, just run the application using `dotnet run`.

If you have not created a database yet, please run `build -Target Generate-MigrationScript` to generate a migration script and run it on a local database. The application will also attempt to seed the database with some base data.

## Code style and linting

Code style and linting of TS/JS/JSON is enforced via TSLint and Prettier. If you have run `yarn`, prettier will be run as a pre-commit hook.

### Editors

Both Visual Studio and Visual Studio Code work well with the project.

Recommended extensions for Visual Studio:

- ReSharper
- TSLint
- [Prettier](https://github.com/madskristensen/JavaScriptPrettier)

Recommende extensions for Visual Studio Code:

- Editor support
- csharp
- Code formatting and linting
- tslint
- vscode-prettier
- vscode-status-bar-format-toggle
Loading

0 comments on commit 04b16e1

Please sign in to comment.