Skip to content

2alheure/go_standard_auth_api

Repository files navigation

Standard Auth API (written in Golang)

The project

This project is a simple auth API written in Go. It's been thought to follow the best code practices and easily maintainable and expandable.

It includes a handling for login, registering, recovering and getting information on an account. It creates and uses a token.

It has been inspired by the article of Adigun Hammed Olalekan. Go check his work.

Init the project

In order for the project to run, you need to set up your environment. To do so, please create a file named my.env at the root of the project, following the same pattern as the provided .env file.
Then you can go build the app.

Or you can just execute the install.sh file, which does exactly the same.

Documentation

Complete documentation can be found in the docs directory. It has been generated using apiDoc. An online version is available on my website or on GitHub.

Dependances

This project uses some dependances :

Go check their work !