Developer Documentation - sandhya698/GDP-Project-Team06 GitHub Wiki

Tools/services used:

  • Back-end: NodeJS
  • Front-end: ReactJS
  • Database: MongoDB

Directions to set up a development environment:

Go to the project repo: Project Repo

  • Download and Extract Files: Download the zip file and extract its contents to the desired location.
  • Open Project in Visual Studio Code: Launch Visual Studio Code and open the extracted project folder.
  • Access VS Code Terminal: • Click on more Options on the top of the screen. • navigate to Terminal. • Select New Terminal to open a terminal in VScode.
  • Navigate to Client Directory: In the terminal, type cd client and press Enter.
  • Install Client Dependencies: Run the command npm install --force in the terminal and press Enter. Wait for the installation to complete.
  • Open New Terminal: Click on "+" icon to open a new terminal in VS Code.
  • Navigate to Server Directory: In the new terminal, type cd server and press Enter.
  • Install Server Dependencies: Run the command npm install in the terminal and press Enter.

Directions to run the code for testing:

Go to the project repo: Project Repo

  • Download and Extract Files: Download the zip file and extract its contents to the required location.
  • Open Project in Visual Studio Code: Launch Visual Studio Code and open the extracted project folder.
  • Access VS Code Terminal: • Click on more Options on the top of the screen. • navigate to Terminal. • Select New Terminal to open a terminal in VScode.
  • Navigate to Server Directory: In the terminal, type cd server and press Enter.
  • Install Server Dependencies: Run the command npm install in the terminal and press Enter. Wait for the installation to complete.
  • Start Server: Run either npm start or npm run dev command in the terminal. You should see the output: "listening on port: 1432".
  • Open New Terminal: Click on “+” icon to open a new terminal in VS Code.
  • Navigate to Client Directory: In the new terminal, type cd client and press Enter.
  • Install Client Dependencies: Run the command npm install in the terminal and press Enter.
  • Start Client: Run the command npm start in the terminal. The application should open in a browser window.
  • Interact with Application: Upon opening the application in the browser, you'll see options to login or signup. Upon successful login, it will redirect to the Home page where you can continue using or testing the application.