Skip to content

juliancolumbres/OfficeQ

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OfficeQ README

  1. Project Assumptions
    a. User has Node.js downloaded to their device (version 16.15.0)
    b. User has Visual Studio Code downloaded to their device
    c. User has a .env file to access the database (For demo purposes, the .env file of the project is omitted. If needed, create a .env file in the 'backend' subdirectory and copy contents from '.env.example'. Then, copy the uri of your MongoDB source to the URI parameter)

  2. Downloading OfficeQ Locally

    a. First, go to https://github.com/juliancolumbres/OfficeQ to find the OfficeQ repository on GitHub
    b. To access OfficeQ locally, click on the Code button to get the link to the repository
    c. Copy the repository URL, and open Git Bash inside your device.
    d. Once inside Git Bash, type in this command: git clone https://github.com/juliancolumbres/OfficeQ.git
    e. Press enter, and the local clone should now be available inside your device

  3. Starting the Backend Server
    a. First, open the OfficeQ project inside Visual Studio Code
    b. Open the terminal inside Visual Studio Code, and make sure to be inside the backend directory by using this command inside the terminal: (cd backend)
    c. Once inside the backend folder, install all dependencies by using the following command: (npm install)
    d. Once all the dependencies are installed, run the command (npm start) to start the backend server

  4. Starting the Frontend server
    a. Open a new terminal inside Visual Studio Code (separate from the backend terminal), and make sure to be inside the frontend directory by using this command inside the terminal: (cd frontend)
    b. Once inside the frontend folder, install all dependencies by using the following command: (npm install)
    c. Once all the dependencies are installed, run the command (npm start) to start the frontend server
    d. After starting the frontend server, the OfficeQ folder should open in your preferred browser

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •