Skip to content

Commit 5eb9e79

Browse files
committed
Add README with build and Docker instructions
1 parent 71b6cad commit 5eb9e79

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Network Infrastructure
2+
3+
This repository contains a web application used to manage network assets such as servers or services. It is built with **ASP.NET Core 9** and uses Entity Framework Core, AutoMapper and FluentValidation. User login is validated against an LDAP directory.
4+
5+
## Features
6+
7+
- CRUD operations for network assets
8+
- LDAP based authentication using `Novell.Directory.Ldap`
9+
- MVC views styled with Bootstrap and icons
10+
- Unit tests with MSTest, Moq and FluentAssertions
11+
- Dockerfile and CI workflow for container builds
12+
13+
## Requirements
14+
15+
- [.NET 9 SDK](https://dotnet.microsoft.com/) or newer
16+
- SQL Server instance for the `NetConnection` string in `appsettings.json`
17+
18+
## Building and running
19+
20+
Clone the repo and restore dependencies:
21+
22+
```bash
23+
dotnet restore
24+
dotnet build
25+
dotnet run --project src/NetworkInfrastructure.Web
26+
```
27+
28+
The application will start on `http://localhost:5062` when using the included launch settings.
29+
30+
## Running tests
31+
32+
Execute the unit tests using:
33+
34+
```bash
35+
dotnet test
36+
```
37+
38+
## Docker
39+
40+
A `Dockerfile` is included. You can build and run locally:
41+
42+
```bash
43+
docker build -t meysam57/networkinfrastructureweb .
44+
docker run -d -p 80:80 meysam57/networkinfrastructureweb
45+
```
46+
47+
The image is also published to Docker Hub and can be pulled directly:
48+
49+
```bash
50+
docker pull meysam57/networkinfrastructureweb:latest
51+
```
52+
53+
Docker Hub repository: <https://hub.docker.com/r/meysam57/networkinfrastructureweb>
54+
55+
## Continuous Integration
56+
57+
A GitHub Actions workflow builds and pushes the Docker image on every push. See `.github/workflows/docker-publish.yml` for details.

0 commit comments

Comments
 (0)