README.md

Organization API

gun-organization is a modern, professional, REST API service developed with Go (Golang) that provides a unified interface to extract and manipulate organizational data from GitHub. This service is specifically focused on returning lists of users, emails, and teams based on the given GitHub organization.

📚 Table of Contents

• Organization API
  • 📚 Table of Contents
  • 💡 Features
  • 🔧 Requirements
  • 🚀 Setup
  • 💻 Usage
  • 🧪 Testing
  • 🤝 Contributing
  • 📜 License

💡 Features

• Retrieves the organization data from GitHub via their API.
• Offers various methods that manipulate the retrieved data.
• Returns a list of users, their corresponding emails, and the teams they are part of.
• Utilizes Go's powerful features to offer efficient, reliable, and concurrent operations.

🔧 Requirements

• Go 1.16 or higher.
• A GitHub Personal Access Token.

🚀 Setup

1. Clone the repository:

   git clone https://github.com/forjadev/gun-organization.git

2. Install the dependencies:

   go mod download

3. Create a .env file in the root directory of the project by copying the .env.example file:

   cp .env.example .env

4. Update the environment variables in the .env file with your own values.
5. Build the project:

   go build

6. Run the server:

   ./main

The server will start running on http://localhost:8080.

💻 Usage

TODO

🧪 Testing

TODO

🤝 Contributing

TODO

📜 License

This project is MIT licensed.