The openIMIS REST API is intended to replace the openIMIS Web Services. It allows the openIMIS mobile phone applications to connect and exchange openIMIS related data.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment section for notes on how to deploy the project on a live system.
In order to use and develop the openIMIS Web Application on your local machine, you first need to install:
- SQL Server instance
- NET Core SDK or Visual Studio with .NET Core SDK
To make a copy of this project on your local machine, please clone the repository.
git clone https://github.com/openimis/rest_api_c-sharp
Restore the NuGet packages needed by the application using VS or nuget CLI.
nuget restore
Compile the application with VS or with dotnet cli tool
dotnet build
Before running the application, you need to change the connection string to connect to the
database in the appsettings.Development.json.dist file within OpenImis.RestApi.config folder. File name should be changed to appsettings.Development.json (.dist extension removed).
"ConnectionStrings":{"IMISDatabase":"Server=Server;Database=IMIS;User ID=User;Password=Password"}
Run the application from VS or using dotnet cli tool
dotnet run -p OpenImis.RestApi
For deployment please read the installation manual.
The user manual can be read on docs.openimis.org.
Copyright (c) Swiss Agency for Development and Cooperation (SDC)
This project is licensed under the GNU AGPL v3 License - see the LICENSE.md file for details.