Full Stack MERN Project

eDoatap - Hellenic National Academic Recognition and Information Center

Team:

1. Γιάννης Κωνσταντίνου 1115201700067
2. Κωνσταντίνος Θεοφίλης 1115201600287
3. Σπύρος Κάντας 1115201800059

Project Repository:

Project Info:

• Front-End: React
• Back-End: Node.js ~ Express-API
• Database: MongoDB
• Deploy: Docker

---

A. Local Execution (Recommended)

1. Dependencies installation [Windows OS]:

To execute our project locally, you need to have Node.js and MongoDB intalled to your system.
You can download the software from the links bellow:
Node.js Download
MongoDB Download

After installation finish:

• Be sure that the direcory C:\Program Files\MongoDB\Server\<version>\bin was successfully created.
• Check your Node.js version with node --version in you command line. The version should appear like v14.17.0

2. Execution

• Navigate to our project root directory /edoatap and type the following command in your commnad line:

npm run dev

and you are ready, now wait and the script will take care of all packages dependencies and it'll make sure to work.

---

B. Docker Execution

1. Dependencies installation [Linux OS]:

• Open a terminal window and update the local repository with:
  sudo apt update
  

• Before installing the software, make sure you remove any old Docker packages on your Ubuntu by running the command:
  sudo apt-get remove docker docker-engine docker.io

• Now let’s install Docker on Ubuntu. Run the following command in the terminal window:
  sudo apt install docker.io
  Type y and hit Enter to confirm the installation. Once the install is completed, the output notifies you Docker has been installed.

• To verify the installation check the Docker version:
  docker –version

  The output displays the Docker version. Should look like this:
  Docker version 20.10.12, build e91ed57

2. Starting Docker Service:

• Start the Docker service by running:
  sudo systemctl start docker

• Then, enable it to run at startup:
  sudo systemctl enable docker

• To check the status of the service, run:
  sudo systemctl status docker
  The output should verify that Docker is up and running.

Note: Before start the docker you need to run this command:

sudo chmod 666 /var/run/docker.sock

Otherwise the docker will not execute correctly or it will show this message in terminal:

• Compose docker:
  docker-compose build

• Run docker:
  docker run -dp 5000:3000 e-doatap-spyrosk_docker_client:latest

---

Project Structure

React Application Structure [Front-End]:

• Inside /edoatap/edoatap/src you will find:
  • a direcory /components having all the html and css elements that our front-end use,
  • a direcory /images and
  • a direcory /utils.
    

Also inside /src you will find the main React file App.js

NodeJS ~ API Structure [Back-End]:

• Inside /edoatap/server you will find:

  • a direcory /models with the Schemas of our MongoDB collections,
  • a direcory /routes with the API call routes (the URIs that out api listen)
  • a server.js file. This is the main file for out connection with the database.