GO-AUTH-SERVICE

This project is an Authentication Microservice built using Golang, designed to handle registration, login, and OAuth2 authentication processes using Google and GitHub as third party authorization providers. This project focuses on security, performance, and flexibility to be integrated with other microservices.

Table of Contents.

• Overview
• Features
• Project Structure
  • Project Index
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Testing
• Project Roadmap
• Contributing
• License
• Acknowledgments

---

Project Structure

└── go-auth-service/
    ├── .github
    │   └── workflows
    ├── Dockerfile
    ├── LICENSE
    ├── Makefile
    ├── README.md
    ├── config
    │   └── config.go
    ├── docker-compose.yml
    ├── docs
    │   └── ROUTE.md
    ├── go.mod
    ├── go.sum
    ├── internal
    │   ├── handler
    │   ├── middleware
    │   ├── models
    │   ├── repository
    │   └── service
    ├── main.go
    └── pkg
        ├── client
        ├── provider
        └── utils

Getting Started

Prerequisites

Before getting started with go-auth-service, ensure your runtime environment meets the following requirements:

• Programming Language: Go
• Package Manager: Go modules
• Container Runtime: Docker

Installation

Install go-auth-service using one of the following methods:

Build from source:

1. Clone the go-auth-service repository:

❯ git clone https://github.com/tuxedo-labs/go-auth-service

2. Navigate to the project directory:

❯ cd go-auth-service

3. Install the project dependencies:

Using go modules  

❯ go build

Using docker  

❯ docker build -t tuxedo-labs/go-auth-service .

Usage

Run go-auth-service using the following command: Using go modules  

❯ go run {entrypoint}

Using docker  

❯ docker run -it {image_name}

Testing

Run the test suite using the following command: Using go modules  

❯ go test ./...

---

Project Roadmap

• Task 1: auth register and login
• Task 2: OAuth2 google & github
• Task 3: Implement feature three.

---

Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the go-auth-service project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/tuxedo-labs/go-auth-service

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.

---

Acknowledgments

• List any resources, contributors, inspiration, etc. here.

---