This project is a part of the SAE-S3.A.01-2023 course at IUT AIX-MARSEILLE. It is a web application that allows students to play online together. We have a some games avaliable, and we can add more games in the future.
the documentation is available in here
- Node.js
- Express for the http server
- Socket.io for the websocket server
- SqLite for the database
- JSDoc for the documentation
- Docker for the deployment
- Bcrypt for the password encryption
- unit-test for the tests
- Selenium for the end-to-end tests
To install the server, you need to :
- get the latest release
- extract the files
- run
npm installin the root folder - run
npm run startin the root folder - that's it, the server is running on port 3000
A docker image is avaliable on docker hub. To install the server, you need to :
- run
docker pull s3a01/main:latestto get the image - run
docker run -p 3000:3000 -v s3a01-data:/data s3a01/main:latestto run the image
you can change the port 3000 to any port you want, this is the port the client will connect to
- that's it, the server is running on port 3000
A docker image is avaliable on docker hub. To install the server, you need to :
- search for the image
s3a01/main:lateston docker hub - run the image, paying attention to:
- redirect the port 3000 to a port on your machine (the client will connect to this port)
- mount a volume to the
/datafolder (this is where the database will be stored)
- that's it, the server is running on the port you chose
To create the documentation, you need to run the following command in the root folder :
npx jsdoc -c jsdoc.config
Note that jsdoc was installed with the
npm installcommand, so you don't need to install it again.
Then,
the documentation will be created in the ./docs<
9E7B
/code> folder as an aggregate of html files.
To create the documentation in markdown, you need to run the following command in the root folder :
make doc
You need to have
makeinstalled on your machine to run this command.
Then,
the documentation will be created in the ./mdDocs folder as an aggregate of markdown files, including the README.md file.
To run the tests, you need to run the make test command in the root folder.
To add a game, you need to :
- Download it from lastest release not avaliable for now
- Put it into
./gamesfolder - Restart the server
To create a new game, you need to :
- Create a folder which will contain all your game's files
- Add all your game's files (e.g index.html, script.js)
Now your folder should approximately look like this:
game
| index.html
│
├───┐ scripts
| | main.js
│
├───┐ images
| │ sprite1.png
| │ sprite2.png
| | icon.png
|
├───┐ sounds
| | music.mp3
|
└───┐ stylesheets
| style.css
- Inside your game folder, make a file named index.json and edit it so it looks like this :
{
"name": "YourGameName",
"version": "0.0.1",
"description": "Your Description Here",
"mainscript": "yourmainscript.js",
"html": "yourhtmlfile.html",
"css": "yourstylesheet.css"
}- simply add this in your index.json :
"images":{
"icon":"images/icon.png",
"sprite1" : "images/sprite1.png",
"sprite2" : "images/sprite2.png"
},
"sounds":{
"music" : "sounds/music.mp3"
}Final result:
{
"name": "YourGameName",
"version": "0.0.1",
"description": "Your Description Here",
"mainscript": "yourmainscript.js",
"html": "yourhtmlfile.html",
"css": "yourstylesheet.css",
"images":{
"icon":"images/icon.png",
"sprite1" : "images/sprite1.png",
"sprite2" : "images/sprite2.png"
},
"sounds":{
"music" : "sounds/music.mp3"
}
}- Zip every files in one archive named yourgamename.game
Note that the archive should not contain your parent folder (game)
But should contain index.json and every other files/folders INSIDE the parent folder
The people that worked in this project are :
Antoine BUIREY - Product Owner
Lila BRANDON - Scrum Master
Tom DIEZ - Developper
Jébril BOUFROUR - Developper
Tanguy HORARD - Developper
Everyone that participated in the project is following a computer science bachelor focused on application creation and project management.
Currently in development, we are working on the first release.