Windows Installation

Windows Installation (Updated 01-19-2024)

Installation Requirements

• Node.JS (LTS Version Recommended)
• Git
• VSCode (Recommended)
  • Note: We highly recommend using VSCode for your IDE because of the extension integration.
• MySQL

Configuration

The configuration steps for VSCode and Git are the same as the Frontend Windows Installation Guide.

MySQL Configuration

1. Install MySQL and choose the larger installation (mysql-installer-community).

• Note: You DO NOT HAVE TO MAKE AN ORACLE ACCOUNT. Just click No thanks, just start my download

2. Select the "Full" option.

3. If needed, opt to install C++.

4. All of these packages should appear in the installation window if you configured the installer correctly.

5. After clicking next for configuring the MySQL server, PLEASE REMEMBER TO SAVE YOUR ROOT PASSWORD WHEN INPUTTING IT. IT'S STUPID HARD TO CHANGE IT.

6. Create a new user with the Add user button. WRITE DOWN THE USERNAME AND PASSWORD

7. Continue clicking next until you reach Finish. No setup is needed for MySQL Router or Samples and Examples. You should see this when you're complete.

8. .env instructions

Project Installation

The project installation steps are the same as the Frontend Windows Installation Guide.

Project Dependency Installation

NOTE: You must be in the Backend project directory to install the dependencies. The project dependency installation steps are the same as the Frontend Windows Installation Guide.

Testing the Project

1. In VSCode's integrated terminal, run npm run api to start the API server.
2. By default, the API server will run on port 3000. The URL to test the API server is http://localhost:3000/.
3. When testing backend endpoints, use programs like Postman (requires account creation), RapidAPI, or Hoppscotch to test the endpoints.

• When inputting data into the body of the request, make sure to use the raw option and select JSON from the dropdown menu.