Program Registration API

The Program Registration API is a .NET Core project designed to simplify program management and registration. It offers CRUD operations, integrates with Azure Cosmos DB, and provides flexibility for application templates and workflow stages. Built with .NET 6.0, it ensures efficiency and scalability.

Key Features

• Effortless Registration: Simplify the registration process for participants.
• Program Management: Easily create, update, and manage various programs, program details, or application forms.
• Secure Data Handling: Ensures input data are validated against XML and SQL injection attacks.
• Customizable Forms: Ensures forms and program details are customisable.
• Documentation: Incorporates Swagger UI endpoints documentation for easy accessibility.
• Integration Capabilities: Seamlessly integrate with other systems and databases.

Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Deployment
• Contributing

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Install .NET Core

Installation

You can use Shell CLI or Visual Studio GUI

1. Clone this repository:

   git clone https://github.com/Meekdavid/APIAccessPro.git

2. Navigate to the Project Directory

   cd APIAccessPro

3. Restore Dependencies

   dotnet restore

4. Build Projects

   dotnet build 
   

Usage

To run the API locally, use the following command:

dotnet run

The API will be available at http://localhost:5000 (HTTP) and https://localhost:5001 (HTTPS) by default. Refer to the swagger API documentation for details on available endpoints and usage. https://41.203.112.130/APIAccessPro/swagger/index.html

Deployment

• Publish API: Build and publish the API project into a folder on your development machine.
• Copy the Published API to the Server: Transfer the published API folder to your Windows server using methods like FTP, SCP, or shared network drives.
• Create an IIS Site: Open IIS Manager, expand the server node, right-click on "Sites," select "Add Website," configure with a unique name, physical path, binding details, and click "OK" to create the site.
• Install the .NET Core Hosting Bundle: If not already installed, install from here
• Configure the Application Pool: In IIS Manager, access "Application Pools," right-click your site's associated pool, choose "Advanced Settings," and set ".NET CLR Version" to "No Managed Code."
• Test the API: In IIS Manager, choose your site in the left pane, then click "Browse" to test your API in a web browser using the configured URL.
• Set Up CosmosDB using an Emulator: Set up the CosmosDB using an Emulator, details can be found on the appsettings.json file.
• Troubleshoot: In case of issues, check logs for errors and verify all required dependencies and configurations, including database connections and app settings.

N/B: You can deploy the .NET Core API to various platforms based on your requirements: Azure App Service, AWS Lambda, Docker, Et Cetera.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:

• Fork the repository.
• Create a new branch for your changes.
• Make your changes and commit them.
• Create a pull request, explaining the purpose of your changes.

🛠️  More About Project

Author

• David Mboko | Youtube | LinkedIn | Academia |

Resources

• Click to View