Robot API

This project was built to visualize the steps we have taken from an Idea to a working API endpoints connected to Database. Additionally, The endpoints is properly documented and tested to mark the finish of this project.

Documentation

Swagger Documentation

Run Locally

Clone the project

  git clone https://github.com/quan-le/SIT331_RobotProject.git

Install dependencies

  Install-Package BCrypt.Net-Next
  Install-Package EntityFrameworkCore.Scaffolding.Handlebars
  Install-Package Microsoft.EntityFrameworkCore.Design
  Install-Package Microsoft.EntityFrameworkCore.Tools
  Install-Package Npgsql
  Install-Package Npgsql.EntityFrameworkCore.PostgreSQL
  Install-Package Swashbuckle.AspNetCore
  Install-Package Microsoft.VisualStudio.Web.CodeGeneration.Design

Running Tests

To run tests, run the following command

  node tester.js

Testing Demo

https://youtu.be/vhdakUcaPaw

Endpoints

• /api/robot-commands
• /api/maps
• /api/users
• /swagger

Tech Stack

Server: .Net 9.0

Database PostgreSQL

Appendix