Skip to content

Commit 04b16e1

Browse files
committed
git init
0 parents  commit 04b16e1

File tree

6 files changed

+508
-0
lines changed

6 files changed

+508
-0
lines changed

.gitattributes

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
build.sh text eol=lf
2+
build.cake text eol=lf

.gitignore

+184
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
## Ignore Visual Studio temporary files, build results, and
2+
## files generated by popular Visual Studio add-ons.
3+
4+
# User-specific files
5+
*.suo
6+
*.user
7+
*.sln.docstates
8+
.vs
9+
.dotnet
10+
tools/*
11+
project.lock.json
12+
13+
# Build results
14+
artifacts
15+
[Dd]ebug/
16+
[Dd]ebugPublic/
17+
[Rr]elease/
18+
x64/
19+
build/
20+
bld/
21+
[Bb]in/
22+
[Oo]bj/
23+
24+
# MSTest test Results
25+
[Tt]est[Rr]esult*/
26+
[Bb]uild[Ll]og.*
27+
28+
#NUNIT
29+
*.VisualState.xml
30+
TestResult.xml
31+
32+
# Build Results of an ATL Project
33+
[Dd]ebugPS/
34+
[Rr]eleasePS/
35+
dlldata.c
36+
37+
*_i.c
38+
*_p.c
39+
*_i.h
40+
*.ilk
41+
*.meta
42+
*.obj
43+
*.pch
44+
*.pdb
45+
*.pgc
46+
*.pgd
47+
*.rsp
48+
*.sbr
49+
*.tlb
50+
*.tli
51+
*.tlh
52+
*.tmp
53+
*.tmp_proj
54+
*.log
55+
*.vspscc
56+
*.vssscc
57+
.builds
58+
*.pidb
59+
*.svclog
60+
*.scc
61+
62+
# Chutzpah Test files
63+
_Chutzpah*
64+
65+
# Visual C++ cache files
66+
ipch/
67+
*.aps
68+
*.ncb
69+
*.opensdf
70+
*.sdf
71+
*.cachefile
72+
73+
# Visual Studio profiler
74+
*.psess
75+
*.vsp
76+
*.vspx
77+
78+
# TFS 2012 Local Workspace
79+
$tf/
80+
81+
# Guidance Automation Toolkit
82+
*.gpState
83+
84+
# ReSharper is a .NET coding add-in
85+
_ReSharper*/
86+
*.[Rr]e[Ss]harper
87+
*.DotSettings.user
88+
89+
# JustCode is a .NET coding addin-in
90+
.JustCode
91+
92+
# TeamCity is a build add-in
93+
_TeamCity*
94+
95+
# DotCover is a Code Coverage Tool
96+
*.dotCover
97+
98+
# NCrunch
99+
*.ncrunch*
100+
_NCrunch_*
101+
.*crunch*.local.xml
102+
103+
# MightyMoose
104+
*.mm.*
105+
AutoTest.Net/
106+
107+
# Web workbench (sass)
108+
.sass-cache/
109+
110+
# Installshield output folder
111+
[Ee]xpress/
112+
113+
# DocProject is a documentation generator add-in
114+
DocProject/buildhelp/
115+
DocProject/Help/*.HxT
116+
DocProject/Help/*.HxC
117+
DocProject/Help/*.hhc
118+
DocProject/Help/*.hhk
119+
DocProject/Help/*.hhp
120+
DocProject/Help/Html2
121+
DocProject/Help/html
122+
123+
# Click-Once directory
124+
publish/
125+
126+
# Publish Web Output
127+
*.[Pp]ublish.xml
128+
*.azurePubxml
129+
130+
# NuGet Packages Directory
131+
packages/
132+
## TODO: If the tool you use requires repositories.config uncomment the next line
133+
#!packages/repositories.config
134+
135+
# Enable "build/" folder in the NuGet Packages folder since NuGet packages use it for MSBuild targets
136+
# This line needs to be after the ignore of the build folder (and the packages folder if the line above has been uncommented)
137+
!packages/build/
138+
139+
# Bower
140+
bower_components/
141+
142+
# Windows Azure Build Output
143+
csx/
144+
*.build.csdef
145+
146+
# Windows Store app package directory
147+
AppPackages/
148+
149+
# Others
150+
sql/
151+
*.Cache
152+
ClientBin/
153+
[Ss]tyle[Cc]op.*
154+
~$*
155+
*~
156+
*.dbmdl
157+
*.dbproj.schemaview
158+
*.pfx
159+
*.publishsettings
160+
node_modules/
161+
162+
# RIA/Silverlight projects
163+
Generated_Code/
164+
165+
# Backup & report files from converting an old project file to a newer
166+
# Visual Studio version. Backup files are not needed, because we have git ;-)
167+
_UpgradeReport_Files/
168+
Backup*/
169+
UpgradeLog*.XML
170+
UpgradeLog*.htm
171+
172+
# SQL Server files
173+
*.mdf
174+
*.ldf
175+
176+
# Business Intelligence projects
177+
*.rdl.data
178+
*.bim.layout
179+
*.bim_*.settings
180+
181+
# Microsoft Fakes
182+
FakesAssemblies/
183+
/src/App/stats.json
184+
*.db

README.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# ![Icon](doc/logo.png) PokerTime
2+
3+
Remote planning poker tool built in ASP.NET Core and Blazor
4+
5+
Licensed: GNU GPL v3.0
6+
7+
[![Build status](https://ci.appveyor.com/api/projects/status/7bjrmgtek7j080d7?svg=true)](https://ci.appveyor.com/project/Sebazzz/PokerTime)
8+
[![CircleCI](https://circleci.com/gh/Sebazzz/PokerTime.svg?style=svg)](https://circleci.com/gh/Sebazzz/PokerTime)
9+
[![Github CI](https://github.com/sebazzz/PokerTime/workflows/Continuous%20integration/badge.svg)](https://github.com/Sebazzz/PokerTime/actions?workflow=Continuous+integration)
10+
11+
## Features
12+
13+
- Realtime retrospective app, ideal for remote teams
14+
- Shortcut support:
15+
- Ctrl + lane number for adding notes or groups
16+
- Ctrl + delete for deleting focused note
17+
- Create password protected retrospectives
18+
- As facilitator, lead the retrospective through the writing, grouping and voting phase.
19+
- Overview with highest voted items
20+
21+
### Browser Support
22+
23+
Developed and tested on:
24+
25+
- Internet Explorer 11
26+
- Microsoft Edge
27+
- Google Chrome
28+
- Mozilla Firefox
29+
30+
## Download
31+
32+
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).
33+
34+
[Follow the installation instructions](docs/Installation.md) in the documentation to install it.
35+
36+
## Building PokerTime from sources
37+
38+
If you prefer to build the application yourself, please follow the [compilation instructions](doc/Building-from-sources.md) in the documentation.
39+
40+
## Screenshots
41+
42+
*to-do*
43+
44+
## Contributions
45+
46+
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.
47+
48+
Please submit an issue to communicate in advance to prevent disappointments.
49+
50+
## Attribution
51+
52+
Application icon:
53+
54+
- Icon made by [Eucalyp](https://www.flaticon.com/authors/eucalyp) from [www.flaticon.com](http://www.flaticon.com/)
55+
56+
Built on:
57+
58+
- [Bulma](https://bulma.io) _CSS framework_;
59+
- [Fontawesome](http://fontawesome.io/) as _icon framework_;
60+
- [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_;

doc/Building-from-sources.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Building PokerTime from sources
2+
3+
If you like to build PokerTime from sources, you can follow the instructions below.
4+
5+
## Prequisites
6+
7+
- [.NET Core 3.1 SDK](https://www.microsoft.com/net/download/core).
8+
- [Node.js LTS](https://nodejs.org/en/download/) or higher (Node.js 10.x is supported too).
9+
- [Yarn](https://yarnpkg.com/en/docs/install) or higher
10+
11+
### Additional prequisites on Windows
12+
13+
- Windows Powershell or Powershell 7
14+
15+
### Additional prequisites on Linux (Ubuntu)
16+
17+
Environment:
18+
19+
- Ensure `yarn` and `node` are in your `PATH`.
20+
- Ensure `dotnet` is in your `PATH`.
21+
22+
For running the build script:
23+
24+
- Ensure the Powershell execution policy is set to [**RemoteSigned**](https://technet.microsoft.com/en-us/library/ee176961.aspx).
25+
26+
## Check-out
27+
28+
Pull the sources from this repository's [home page](https://github.com/Sebazzz/PokerTime).
29+
30+
## Building
31+
32+
Use the build script in the root to build the application:
33+
34+
build
35+
36+
To create a deployment to one of the supported platforms:
37+
38+
build -Target Publish
39+
40+
The results will be emitted in the `build/publish` folder. For additional supported command line parameters run:
41+
42+
build -h
43+
44+
## Development
45+
46+
After you've build the application once you can start developing.
47+
48+
To develop, just run the application using `dotnet run`.
49+
50+
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.
51+
52+
## Code style and linting
53+
54+
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.
55+
56+
### Editors
57+
58+
Both Visual Studio and Visual Studio Code work well with the project.
59+
60+
Recommended extensions for Visual Studio:
61+
62+
- ReSharper
63+
- TSLint
64+
- [Prettier](https://github.com/madskristensen/JavaScriptPrettier)
65+
66+
Recommende extensions for Visual Studio Code:
67+
68+
- Editor support
69+
- csharp
70+
- Code formatting and linting
71+
- tslint
72+
- vscode-prettier
73+
- vscode-status-bar-format-toggle

0 commit comments

Comments
 (0)