Merge branch 'master' of https://github.com/allEyezOnCode/CodeWe

Author: bhasher

README.md

@@ -12,6 +12,14 @@ git clone https://github.com/allEyezOnCode/CodeWe.git
 cd CodeWe
 pip install -r requirements.txt
 ```
+### Build with docker (instable)
+change Host to 0.0.0.0 and run the following :
+
+`sudo docker-compose up`
+
+`sudo docker-compose up -d --no-deps --build`
+
+Help wanted to configure it correctly
 
 ## Usage
 To run the server, open a terminal in the folder and run :

docker-compose.yml

@@ -9,11 +9,11 @@ services:
     ports:
       - '5000:5000'
   db:
-      image: mysql:5.7
+      image: mysql:8.0.20
       ports:
         - "32000:3306"
       command: --init-file /create_db.sql
       volumes:
         - ./db/sql_files/create_db.sql:/create_db.sql
       environment:
-        MYSQL_ROOT_PASSWORD: set_password_here
+        MYSQL_ROOT_PASSWORD: root

src/main.py

@@ -6,68 +6,83 @@
 import sys
 import json
 
-app = Flask(__name__, template_folder='templates')
-app.register_blueprint(api, url_prefix='/api')
+app = Flask(__name__, template_folder="templates")
+app.register_blueprint(api, url_prefix="/api")
 socketio = SocketIO(app)
 
 
-@app.route('/')
+@app.route("/")
+@app.route("/index.html")
 def home():
+    """Render home page."""
     return render_template("index.html")
 
 
-@app.route("/create_document", methods=['POST'])
+@app.route("/create_document", methods=["POST"])
 def create_document():
+    """Create a new document/code file."""
     doc_id = db.create_document()
     return redirect(f"/{doc_id}")
 
 
-@app.route('/<doc_id>')
-@app.route('/editor/<doc_id>')
+@app.route("/<doc_id>")
+@app.route("/editor/<doc_id>")
 def editor(doc_id):
+    """Enter editor with document id.
+
+    :pre:
+        doc_id: str, 5 char - in database
+    """
     content = db.get_document(doc_id)
-    content['content'] = json.loads(content['content']) 
+    content["content"] = json.loads(content["content"])
     if doc_id is not None:
-        return render_template('editor.html', document=content)
+        return render_template("editor.html", document=content)
     return abort(404)
 
 
-@app.route('/tos')
-@app.route('/tac')
+@app.route("/tos")
+@app.route("/tac")
+@app.route("/termsofservice")
+@app.route("/terms-of-service")
 def tos():
-    return render_template('legal/tos.html')
+    """Render terms of service."""
+    return render_template("legal/tos.html")
 
 
-@app.route('/privacy')
+@app.route("/privacy")
+@app.route("/privacypolicy")
+@app.route("/privacy-policy")
 def privacy():
-    return render_template('legal/privacy.html')
+    """Render privacy policy."""
+    return render_template("legal/privacy.html")
 
 
-@app.route('/licence')
+@app.route("/licence")
 def licence():
-    return render_template('legal/licence.html')
+    """Render Project licence."""
+    return render_template("legal/licence.html")
 
 
 @socketio.on("join")
 def on_join(data):
-    room = data['room']
+    room = data["room"]
     join_room(room)
 
 
-@socketio.on('update text')
+@socketio.on("update text")
 def update_text(data):
-    emit('text updated', data, room=data['room'], include_self=False)
+    emit("text updated", data, room=data["room"], include_self=False)
 
 
-@socketio.on('save')
+@socketio.on("save")
 def update_text(data):
-    db.update_document(data['room'], json.dumps(data['requests'][0]['data']))
+    db.update_document(data["room"], json.dumps(data["requests"][0]["data"]))
 
 
 @app.errorhandler(404)
 def page_not_found(e):
-    return render_template('404.html'), 404
+    return render_template("404.html"), 404
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     socketio.run(app, *sys.argv[1:], debug=DEBUG)