Build Code

How to How-to Compile & Run

General

Warning

Info needed

Dependencies

Warning

Info needed

Steps

Warning

Info needed

---

---

Backend

Warning

Info needed

Dependencies

Warning

Info needed

Steps

Warning

Info needed

• Install Visual studio 2022
• 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
• Make a local copy of the repo
• open SailMapper in visual studio /comp4350-project/backend/SailMapper.sln
• In the solution explorer tab, right click SailMapper and open a terminal
• Run: dotnet restore, dotnet tool install --global dotnet-ef, then dotnet ef database update
• At the top of visual studio ensure that "SailMapper" is the startup item and "https" is the startup project, click run
• To run tests, in the terminal dotnet test
• 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

Warning

Info needed

Dependencies

Warning

Info needed

Steps

Here are the steps to get our React frontend running on your machine:

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. Navigate to the frontend/react folder in the project
3. Run npm install in a terminal
4. Run npm run dev in a terminal and go to http://localhost:5173/ in a browser to access the running website
5. 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 (Do last, may take long)

Warning

Info needed

Dependencies

Warning

Info needed

Steps

Warning

Info needed

---

Finished