Skip to content

WesleyYDS/WebAPI_Orgs

Repository files navigation

WebAPI - Organizations

This repo is used to receive repositories data from the GitHub API, based on the organization. It uses a .NET WebAPI for the logic.

Made by Wesley Yago Last Commit Contributors License Check out my LinkedIn!

---

Table of Contents


🤖 How it works

This API consumes the GitHub API and pulls repositories data from a specific organization.


🚀 Getting Started

Prerequisites

Setup

Instructions to use:

  • download or clone the repo
  • run a Shell prompt inside the project's main folder (WebAPIClient)
  • enter the following command and press Enter:
dotnet run
  • open a request at Insomnia/Postman or go to your browser at https://localhost:5001
  • consume the API by making a GET request with the organization name as a parameter
  • voilà!

📋 Features

The program should be able to:

  • Consume the GitHub Repositories API.
  • Store organizations info locally using Cache.
  • Use FeatureManagement to toggle Cache being used.
  • Cache expiration time defined by a parameter in appSettings.
  • Perform Unit Testing.

Documentation

This project uses the following Commit Guidelines:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

📌 Support

Contact and support me through the following social medias:


📝 License

License

This project is licensed under the MIT License - see the LICENSE file for details.


🧰 Being developed by Wesley Yago!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages