BingoMeetings-documentation-part 23

Bingo

Bingo is a small project, written in TypeScript , and developed with Alexandru Badita in launch break (one hour - more or less). You can find sources at https://github.com/alexandru360/PresentationBingoCards/ . Those are my blog posts for Bingo : ( scroll below for the post)

Nr	Link
1	Create meeting
2	Create Tests
3	Finalize Create meeting
4	Sharing meeting
5	Keep Score
6	Add obsolete
7	Finalizing obsolete
8	End meeting
9	Dockerize tests
10	Azure CI tests
11	Yarn workspaces
12	CLI
13	Intermezzo - CLI improvements
14	typescript compile run with node
15	NestJS ,swagger and create a meeting
16	Finalizing API
17	Intermezzo - jest vs jasmine error
18	Refactor WebAPI and test service
19	Heroku Deploy NestJs
20	Angular
21	Deploy Angular to GitHub
22	WebAPI and Web
23	Documentation
24	Documentation of the code
25	Conclusions

Not so much here – just is the most time consuming part. You should imagine for who you are writing ( technical / user ?), what are his interests ( installing application / running the project ) and how to convey information.

Here we will write for the persons that wants to install the project , run it and modify the source code.

First , documentation for installing the project and run it.

You can read what I have done at https://github.com/alexandru360/PresentationBingoCards/wiki

Do not forget that you are writing for 2 kind of OS : Windows and Linux ( Mac also, but I do not have a Mac)

So the installation part is composed of something like

For running the project in a console way, goto dockerize folder and run

bingo_cli.bat

( for Linux, please go to dockerize folder and

chmod +777 ./bingo_cli.bat

./bingo_cli.bat

 

This can ( and should) be improved over time, as need arrives. Also, if we want to be on standards, we should look at Community Standards (https://github.com/alexandru360/PresentationBingoCards/community) : Description, License,ReadMe done. Contributing, Issue Templates and Pull Request template – too much for a single developer….