Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 2.14 KB

README.md

File metadata and controls

75 lines (45 loc) · 2.14 KB
Raw

Malawi Meta API 🇲🇼

A .NET Minimal API implementation of the Malawi Meta API.

Description

The Malawi Meta API is a simple yet powerful application built to serve information about Malawi's districts and regions. It delivers reliable data through a clean API, which can be accessed by developers and researchers for a variety of purposes.

Motivation

This project was born out of the need for a centralized, easily accessible source of accurate information about Malawi's districts and regions. By exposing this data through a public API, we aim to facilitate research and development projects, foster innovation, and contribute to the growing digital economy in Malawi.

Documentation

You may find out about the documentation here

Technologies

The application is built with the following technologies:

Local Development

Prerequisites

  • .NET 7.0 SDK

Getting Started

  1. Clone the repository to your local machine.

  2. Navigate to the root directory of the project in the terminal:

    cd MalawiMeta.Api

  3. Restore the project dependencies:

    dotnet restore

  4. Build the application:

    dotnet build

  5. Run the application:

    dotnet run

The application runs on http://localhost:5000/.

How to Contribute

Contributions to the project are welcome! Here are the steps to contribute:

  1. Fork the project repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes.
  4. Submit a pull request.

Please make sure your code adheres to the existing style for consistency.

License

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

Author