AuthMe

A solution for digital identity on the Internet
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact
7. Acknowledgments

About The Project

AuthMe gives people an opportunity to identify themselves to modern applications and in the same time protects their rights and privacy.

The web application features:

• Authentic digital identity
• A convenient system for digital documents
• A way to fight cyberbullying, online crimes, etc.

The solutions follows the microservice approach and is designed to be scalable and able to withstand lots of requests per second. The architecture is security oriented.

(back to top)

Built With

The following frameworks/technologies were used to build the project:

• Spring
• Microsoft Azure
• ASP.NET Core
• Kubernetes
• Docker
• Terraform

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Make sure you have the following packages/SDKs installed:

• Java - OpenJDK 17
• .NET Core 6
• Docker and docker-compose
• A valid Azure subscription

Installation

_Below is an example of how to run the microservices and start the database services using docker-compose and the officially published images on DockerHub. _

1. Clone the repo

   git clone https://github.com/r46narok/AuthMe.git

2. Navigate into the root directory

   cd AuthMe

3. Start the images in detach mode

   docker compose up -d # Windows

   docker-compose up -d # Linux

(back to top)

Usage

To use the web application start a browser and go to http://localhost:8080. There you will interact with the front portal, written in Java Spring.

(back to top)

Roadmap

• Update README
• Document the project further

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Authors

👤 Dimitar Vasilev and Stanimir Kolev

• Github: @BaiMitio and R46narok

(back to top)

Acknowledgments

The following libraries were used in the development of the project:

• MediatR - .NET library for CQRS and Mediator pattern
• FluentValidation - .NET library for building strongly-typed validation rules
• AutoMapper - .NET convention-based object-object mapper
• Spring Security - Spring authentication and access-control framework
• Thymeleaf - Spring template engine

(back to top)