/CE66-17-WebFrontendBuilder

Primary LanguageHTMLMIT LicenseMIT

Installing the Program on Your Computer

System Requirements

  1. Operating System: Windows, macOS, or Linux
  2. Minimum RAM: 4 GB
  3. Minimum Disk Space: 10 GB
  4. Screen Resolution: At least 1920x1080 pixels

Installation Steps

  1. Install Visual Studio Code or any other Text Editor you prefer.
  2. Download and install Node.js version 20.9.0
  3. Download and install Golang version 1.21.5
  4. Download and install Xampp version 8.0.30
  5. Open Terminal or Command Prompt and navigate to the directory where you want to install the project.
  6. Clone the project from GitHub using the command: git clone https://github.com/flexix-developer/CE66-17-WebFrontendBuilder.git
  7. Navigate to the cloned folder. You'll find frontend, backend folders, and a docker-compose.yml file.
  8. For Web Application, go to the frontend folder.
  9. Use the command npm install to install the required dependencies.
  10. Use the command npm start to open the website in your browser.
  11. For Web Server, open Xampp and start Apache and MySQL modules.
  12. Open your browser and go to http://localhost/phpmyadmin/ to create a database named backend_db with Collation as utf8mb4_general_ci.
  13. For API Server, go to the backend folder.
  14. Open the .env file and verify the correctness of MYSQL_DNS, which should be root:@tcp(127.0.0.1:3306)/database_db?charset=utf8mb4&parseTime=True&loc=Local.
  15. Open the main.go file and and verify the correctness of r.RUN(), which should be r.RUN("localhost:8081")
  16. Use the command go get . to install the required libraries.
  17. Use the command go run . to start the API Server.
  18. Access the website through your browser by visiting http://localhost:3000/

Installing the Program with Docker

System Requirements

  1. Operating System: Windows, macOS, or Linux
  2. Minimum RAM: 8 GB
  3. Minimum Disk Space: 15 GB
  4. Screen Resolution: At least 1920x1080 pixels

Installation Steps

  1. Install Visual Studio Code or any other Text Editor you prefer.
  2. Install Docker Desktop, which can be downloaded from Docker's official website
  3. Install Docker Compose, which can be downloaded from Docker's official documentation
  4. Open Terminal or Command Prompt and navigate to the directory where you want to install the project.
  5. Clone the project from GitHub using the command: git clone https://github.com/flexix-developer/CE66-17-WebFrontendBuilder.git
  6. After cloning, you will find frontend, backend folders, and a docker-compose.yml file.
  7. Configure the API Server to connect to the Database by navigating to the backend folder.
  8. Open the .env file and verify the correctness of MYSQL_DNS, which should be root:root@tcp(database:3306)/database_db?charset=utf8mb4&parseTime=True&loc=Local
  9. Open the main.go file and and verify the correctness of r.RUN(), which should be r.RUN("0.0.0.0:8081")
  10. Use the command docker-compose up -d or docker compose up -d to automatically create containers.
  11. Access the website through your browser by visiting http://localhost:3000/