An open-source Kahoot-like project written with meteor and react.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
Give examples
A step by step series of examples that tell you have to get a development env running
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
Explain how to run the automated tests for this system
Explain what these tests test and why
Give an example
Explain what these tests test and why
Give an example
+---api
| +---games
| | games.js # Definition of games collections
| | games.test.js
| |
| \---server
| methods.js # Writing to games collections
| methods.test.js
| publication.js # Reading from games collections
| publication.test.js # Test of reading games collections
|
|
+---startup
| +---both
| | constants.js # Constants in the app
| | index.js # Import modules used by both client and server through a single index entry point
| |
| +---client
| | index.js # Import client startup through a single index entry point
| | routes.js # Routing in client side
| |
| \---server
| authentication.js # authentication by gitlab
| index.js # Import server startup through a single index entry point
| register-api.js # Containes all file's server and run them
| security.js # Security configuration file
|
\---ui
+---components
| |
| \---pivot-table
| | pivot-table.js
| |
| \---locales
| pivot.he.js
| pivot.he.js.map
| pivot.he.min.js
| pivot.he.min.js.map
|
+---layouts # Wrapper components for behaviour and visuals
| game.js
| login.js
| manage.js
|
+---pages # Entry points for rendering used by the router
+---game
| home.js
| owner-router.js
| player-router.js
| router.js
|
+---both # Game pages for owner and player
| game-close.js
| leaders.js
| question-statistics.js
| question.js
| winner.js
|
+---owner # Game pages for owner
| lobby.js
|
\---player # Game pages for player
answer-sent.js
instructions.js
Add additional notes about how to deploy this on a live system
- Meteor - Platform for building web and mobile apps in pure JavaScript
- React - JavaScript library for building user interfaces
- Astronomy - Model Layer for Meteor collections
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Billie Thompson - Initial work - PurpleBooth
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone who's code was used
- Inspiration
- etc