auth

Table of Contents

• Introduction
• Features
• Requirements
• Quick Start
• Testing
• API
• Acknowledgements

Introduction

This repository contains authentication microservice which enables to authenticate either GitHub or Google.

Features

• Programmist is able to log in to application using GitHub account
• Non-programist is able to log in to application using Google
• The information is stored in user database

Requirements

The application can be run locally or in a docker container, the requirements for each setup are listed below.

Local

• NodeJS

Docker

• Docker

Quick Start

Run Local

$ npm install

$ npm start

Application will run by default on port 1234

Run Docker

First build the image:

$ docker-compose build

When ready, run it:

$ docker-compose up

Application will run by default on port 1234

Configure the port by changing services.api.ports in docker-compose.yml. Port 1234 was used by default so the value is easy to identify and change in the configuration file.

Testing

Application testing is executed in GitHub Actions in actions/setup-node. You can find configuration files in ./.github/workflows/.

API

This microservice has three endpoint which are listed below.

1. POST /auth/google

Check if user exists in out database by using Google Auth. Returns user after check or database save.

Acknowledgements

• hendrysiak