Overtake

Monorepo for Overtake.

Projects

This monorepo contains all complete stack of components needed for running the Overtake application:

• server: Backend API server written in C# with .NET.
• web: Frontend web app written in TypeScript with Next.js.

server is responsible for initializing a new database with the initialization script.

Quickstart

This repository provides a docker-compose.yml file for quickly running the entire application stack without requiring the prerequisites to be installed.

With Docker Compose installed:

$ docker compose up -d --build

and then:

• the backend server will be accessible locally at http://localhost:8080/; and
• the web app will be served locally at http://localhost:3000/.

if you want to use live reloading while working on the frontend UI:

• navigate to the web directory(cd web)
• and input:

$ npm run dev

• the web app will still be available locally at http://localhost:3000/. however it will now utilize live reload.

To stop the stack:

• if using live reload(npm run dev):

$ CTRL+c

• then in your main project folder:

$ docker compose down

Note

On Windows or macOS, a Docker Desktop installation comes with Compose functionalities. There's no need to install Compose separately in this case.

Prerequisite

Depending on the component, different toolchains need to be installed to successfully build and run them.

server

The backend server is developed with .NET 8.0. The .NET SDK must be installed to develop the server. To check whether .NET SDK has been successfully installed:

$ dotnet --version
8.0.303

web

The frontend web app is developed with Next.js. Node.js must be installed:

$ node --version
v20.16.0

In addition, the project uses the yarn package manager, which can be installed with:

$ npm install -g yarn

To check whether yarn is properly installed:

$ yarn --version
1.22.22