Skip to content

Lucria/Scooter_Project_Backend

Repository files navigation

Beam Software Engineering Intern Exercise

.NET Core Build

This is a system that is capable of fetching a set number of scooters specified by a user for a given latitude, longitude within a certain distance, and plot it onto a map.

The goal of building this system is for Beam's Software Engineering Internship Exercise.

This repository will house both the backend and the database for this system. Both the backend and the database system will be hosted from Docker containers. The backend API server is done in C# utilizing .NET Core, while the database is a PostgresSQL database.

Rough Architecture Diagram

Architecture Diagram

Prerequisites

  • .NET Core v3.1

    You may type dotnet --version to verify that the downloaded version is 3.1 or above. Follow the instructions here to download .NET Core.

  • Docker (Essential)

    The application is designed to be run within a Docker container, especially the database. Docker will also bring further convenience during development. Therefore, it is essential that Docker is installed in your computer for testing.

    Follow the instructions here to download Docker.

Installing

  • Clone the repository to your local machine using Git.

Using HTTPS:

git clone https://github.com/Lucria/beam_intern_test.git

Using SSH:

git clone git@github.com:Lucria/beam_intern_test.git

Restoring NuGet Dependencies

  1. Run dotnet restore "Beam_intern.csproj" in the root directory to restore NuGet dependencies.

Instructions On How To Run

  1. Navigate to the root directory of this project
  2. Create a volume mount for the database using docker volume create test_db. The volume will be used by our PostgresSQL database later on.
  3. Start the docker containers for the API server and the database using docker-compose up -d --build. This command will forcefully rebuild all images to ensure images are the latest.

Testing

Automated Testing to be added in the future

Deployment

To be added in the future

License

To be added in the future

About

Backend System for Scooter Project in .NET 3.1

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published