diff --git a/README.md b/README.md index 429d467c55a01db3f77f618064b2fecc12e2f6d5..26ea27211f27c347f38b09fb7736b95b53a20951 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ ## Documentation -# \ No newline at end of file +Socket.io Chatroom for Cloud-Computing +=== + +Diagramm provided in the repository. +Code is commentet. + +Used technologies: Node.js, Express, Mongoose, Socket.io, JWT, Cookie-Session, Crypto, ejs, bcrypt + + +Installation +=== + +#### 1. Clone the Repository + +```sh +git clone https://gitlab.reutlingen-university.de/luzzi/cloud-computing_2022.git + +``` + +#### 2. Install the Dependencies + +```sh +npm install +``` + +#### 3. Start the Server + +```sh +npm start +``` + +> View on localhost:3000/start