MicroKey

MicroKey is an open-source, microservices-based application that integrates a Django backend with a Golang Gin service, providing a seamless and scalable architecture for authentication and API management.

  _____________________
 /  Microservices       \
|   ____     ____        |
|  |    |   |    |       |
|  |Django  | Gin|       |
|  |____|   |____|       |
|                        |
 \______________________/
        Spinning...

Microservices Architecture

MicroKey leverages a microservices architecture to ensure scalability, maintainability, and flexibility:

1. Django Auth Service: Handles user authentication and management.
2. Golang Gin API Service: Provides lightweight, high-performance API endpoints.

Features

• Django Backend: Handles user authentication and serves REST APIs.
• Golang Gin Service: Lightweight middleware for authentication.
• SQLite Database: Lightweight, serverless database for easy setup and testing.
• Docker Support: Easy to set up and run using Docker Compose.
• GitHub Integration: Version control and collaboration.
• Open Source: Contributions are welcome and encouraged!

Technology Stack

Project Structure

MicroKey/
├── Dockerfile.django
├── Dockerfile.gin
├── docker-compose.yml
├── auth-service-django/
│   ├── apps/
│   │   └── accounts/
│   ├── config/
│   ├── manage.py
│   ├── db.sqlite3
│   ├── requirements.txt
│   └── myenv/
├── gin-auth-api/
│   ├── main.go
│   ├── middleware.go
│   ├── go.mod
│   └── go.sum
└── README.md

GitHub Integration

Getting Started

Prerequisites

Installation

1. Clone the repository:

   git clone https://github.com/vivekjha1213/MicroKey.git
   cd MicroKey

2. Build and run the services:

   docker-compose up --build

3. Access the services:

   • Django API: http://localhost:8000
   • Golang Gin API: http://localhost:9000

Development

Django Development

cd auth-service-django
pip install -r requirements.txt
python manage.py migrate
python manage.py runserver

Golang Gin Development

cd gin-auth-api
go run main.go

Contributing

We welcome contributions! Here's how you can contribute:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

Get Involved

Let's build something amazing together!