Getting started with developing

Jump to bottom

github-actions[bot] edited this page Sep 11, 2025 · 1 revision

Getting Started with Developing mnestix-proxy

Prerequisites

Before you start developing with mnestix-proxy, ensure you have the following installed:

.NET 8 SDK (required for building and running the project)
Git (for version control)
Docker (optional, for containerized development and testing)

Project Structure

The main source code is located in the mnestix-proxy folder. Key directories and files include:

Program.cs — Application entry point
Authentication/ — Authentication logic and middleware
Configuration/ — Configuration options and classes
Exceptions/ — Custom exception types
Middleware/ — Custom ASP.NET Core middleware
Services/ — Service implementations and interfaces
appsettings.json / appsettings.Development.json — Configuration files
.github/workflows/ — CI/CD workflows

Setup Instructions

Clone the repository:

git clone https://github.com/eclipse-mnestix/mnestix-proxy.git
cd mnestix-proxy/mnestix-proxy

Install dependencies:
- Make sure you have the .NET 8 SDK installed.
Configure environment variables:
- Update appsettings.Development.json or appsettings.json as needed for your environment.
Run the development server:
```
dotnet run
```
Run tests:
```
dotnet test
```

Docker Development (Optional)

Build and run the project using Docker:

docker build -t mnestix-proxy .
docker run -p 5000:5000 mnestix-proxy

See .dockerignore and docker-compose.yml (if present) for details.

Additional Notes

Use dotnet restore if you encounter missing dependencies.
Pull the latest changes from the main branch before starting new work.

Useful Links