Build Code

How to How-to Compile & Run

Note

If you don't have access to a required resource you can reach out to us

---

Backend [Server & API]

Steps

1. Install Visual studio 2022
2. Install MySql community https://dev.mysql.com/downloads/mysql/
   • If the DB username and password need to be changed in the project, SailDBContext.cs and appsettings.json should be updated accordingly
3. Pull the latest release from the Project Repo (Please note that we have 2 repos. you do not want to use the admin repo)
4. open SailMapper in visual studio /comp4350-project/backend/SailMapper.sln
5. In the solution explorer tab, right click SailMapper and open a terminal
6. Run: dotnet restore, dotnet tool install --global dotnet-ef, then dotnet ef database update
7. At the top of visual studio ensure that "SailMapper" is the startup item and "https" is the startup project, click run
8. To run tests, in the terminal dotnet test
9. To run Linting, in the terminal dotnet format SailMapper.sln

If at any point there is an error message requesting which project some code should be ran against, you must be in the /SailMapper folder and append SailMapper.sln to the command

---

---

REACT [Frontend: RC_Client]

Steps

1. If you don't already have Node.js, download and install it from https://nodejs.org/en and confirm it setup correctly by running node --version
2. Pull the latest release from the Project Repo (Please note that we have 2 repos. you do not want to use the admin repo)
3. Navigate to the frontend/react folder in the project
4. Run npm install in a terminal
5. Run npm run dev in a terminal and go to http://localhost:5173/ in a browser to access the running website
6. Run npm run test in a terminal to run the tests
   • You can also run npm run test:ui to get the test results listed out in a browser window

---

---

Flutter [Frontend: Racer_Client]

Warning

For the student(s) who are Building & Running our project
Unless you are working in a similar environment complete Flutter last.

Setup/Dependencies

If you follow Flutter's Start building Flutter Android apps on Windows, with default settings, (plus any optional suggestions that you may receive from your IDE or tutorial) you will have nearly an identical setup to mine.

The following point(s) may not be reasonable for you to reproduce:

• Windows 11 environment

more info on environment

What you should have:

• VS Code
  • Version: 1.77 (or later)
• VS Code Extensions:
  • Flutter extension for VS Code
  • Dart dependency for Flutter
• Flutter (For Mobile Client)
  • Version: 3.24.3
• Dart (For Flutter)
  • Version: 3.5.3 (Flutter handles)
• Android Studio
  • Android Emulator
    • Phone: Pixel 7a
    • Version: Android 15
    • API Level: 35

Pre-Building Tasks

0. Everything above
1. Grab Files
2. Pull the latest release from the Project Repo (Please note that we have 2 repos. you do not want to use the admin repo)
3. Install Emulator
4. Start your emulator
5. Open Android Studio
6. Click "More Actions"
7. Click "Virtual Device Manager"
8. Press the play button
9. Open your repo copy in VS Code
10. Navigate to the Flutter root, cd frontend/flutter_client (assuming you are in the project root)
11. On the sidebar for VS Code click the Bug on the Play button.
12. At the top there is now a green arrow with a drop-down menu
13. Select your emulator
14. Click the green arrow. (this lints, compiles, CI tests, and more, all in one click)
15. You did it 🥳
16. Wrapping up

• The emulator may take a few minutes to start up each time
• You may need to relaunch the emulator twice, I found it unstable on my system
• A common problem is your PATH variables are not set up correctly
• More info can be found on our Wiki, (Not exhaustive)
• The VS Code sidebar contains more info for Building. In the order below
  • Run and Debug:
  • Testing: To see your CI testing results
  • Flutter: Dev Tools and Debugging

---

Finished