Merge pull request #2 from joe-inz/develop

Merging develop into master

Author: joeloudjinz

.env.example

@@ -0,0 +1,20 @@
+# the environment of the application
+NODE_ENV=development
+# port of the application
+PORT=3000
+
+# leav it commented
+# BASE_URL=http://localhost:3000
+
+# token secret value to generate tokens
+TOKEN_SECRET=
+
+# database host, for local use 'localhost'
+DATABASE_HOST=localhost
+# name of the database
+DATABASE_NAME=cnc_iiot
+DATABASE_USERNAME=root
+DATABASE_PASSWORD=
+
+# this is used for mysql docker container, leave it empty when using local database
+DATABASE_ROOT_PASSWORD=

.gitignore

@@ -1,2 +1,9 @@
 node_modules
-client/
+client/
+client
+test/
+resources
+.jshintrc
+server/.eslintrc.js
+server/.env
+.env

README.md

@@ -0,0 +1,25 @@
+# Loudjein.cnc
+Back-end project that interacts with CNC machine through serial port, it generates a gcode file from an uploaded image. 
+
+## Structure
+1. Agnets Management:<br>
+  Handles all operation on agnets, nad admins, the users of the system.
+1. Authentication:<br>
+  Handles all the operations of authentication, including token refresh process.
+1. Config:<br>
+  Holds all the files that take configurtion as a content, such as database, multer and the server configuration.
+1. Files Handler:<br>
+  Handle all the operation on the files and directories in the system, the types of files in the system are:
+   1. Images
+   2. Gcode files
+   3. log files
+1. Image Converter:<br>
+  Take care of the full process of converting an image, from uploading it to creating gcode file.
+1. Middlwares
+  Used middlewares in the system
+1. Public Folder:<br>
+  The generated front-end assets by VueJs cli, [Project repo](https://github.com/joe-inz/cnc-controller-fe)
+1. Socket Manager:<br>
+  Handles all the operations for real time updates to the client.
+1. Transmitter:<br>
+  Handles the transmission process operations.

client

@@ -1 +1 @@
-Subproject commit 3d48fba859ca105704978ce3b47f56396387d77c
+Subproject commit 4e91e6da96554ede4e7fb45a7fffec1782f3e2b4