Skip to content
This repository was archived by the owner on Dec 11, 2020. It is now read-only.

Latest commit

 

History

History
80 lines (52 loc) · 2.42 KB

File metadata and controls

80 lines (52 loc) · 2.42 KB

SWE4103_Project

Presented to you by TEAM 2!

CircleCI will run on each merge request to ensure the build works correctly.

Running the project

Linux

  • Install dotnet as well as aspnet-runtime.
  • Run these commands:

cd frontend && npm ci && cd ..

export ASPNETCORE_Environment=Development && make build

make run

You can now connect to the development server by typing localhost:5000 into your web browser

MacOS

brew cask install dotnet

  • Now you must install a .Net Core SDK found here.

  • Then run these commands:

export ASPNETCORE_Environment=Development && dotnet build

cd frontend && npm ci && cd ..

dotnet run --project backend/backend.csproj

You can now connect to the development server by typing localhost:5001 into your web browser

Windows

Two different ways:

  1. Using Ubuntu (a Linux command prompt application easily available for Windows)
  • Download Ubuntu from the Microsoft store
  • Follow the instructions from the Linux section above
  • You may need to update your npm using before running dotnet run

npm install -g npm

NOTE: With Ubuntu in order to get to your Documents directory, for example, you have to first do (with your own Username)

cd /mnt/c/Users/Maddy/Documents/

  1. On Windows

cd frontend

npm ci

cd ..

dotnet run --project backend/backend.csproj

You can now connect to the development server by typing localhost:5000 into your web browser

NOTE: The easiest code editor to use with C# will likely be Visual Studio Code, so download that as well.

To find out how to build and run the front end see this link If you have any questions running the frontend please ask for help from someone on the team!

Running tests

Running make test will run all tests in the project (frontend and backend)

Frontend tests

To run tests for frontend execute:

cd frontend && npm test

This will take you to a new window that allows you to run tests.

Backend tests

To run tests for backend execute:

dotnet test

This will run all the unit tests contained within the test folder.

Happy developing!