HiP-EmailService is a MicroServer to send Emails which is developed by the project group History in Paderborn. It is developed to send Emails form the system 'History in Paderborn'.
See the LICENSE file for licensing information.
See the graphs page for a list of code contributions.
HiP-EmailService is a REST API built on .NET Core 1.1 . Below are the requirements needed to build and develop this project,
- .NET Core for Windows, Linux or macOS.
If you want to call this API programatically from another .NET application, the recommended way is generating a client class automatically via autorest.
- Install the autorest tool
- Run the EmailService and then download the swagger.json from localhost:5002/swagger/v1/swagger.json and save it to your project directory
- Create the client by running the following command (change the
YOUR_PROJECT_NAME
string, obviously)
autorest -Input swagger.json -CodeGenerator CSharp -OutputDirectory . -Namespace PaderbornUniversity.SILab.Hip.YOUR_PROJECT_NAME -ClientName EmailClient
- Move the generated
EmailClient.cs
,IEmailClient.cs
andEmailClientExtensions.cs
into a newly created folderClients
and change theirnamespace
declarations by adding.Clients
to their end - You can now instantiate the
EmailClient
vianew EmailClient()
and then call the REST API methods of the EmailService using it's async methods.
- Visual Studio 2017
- Visual Studio Code with C# extention.
- Clone the repository.
- Create a new file
appsettings.Development.json
atscr/EmailService
. (Seesrc/EmailService/appsettings.Development.json.example
). - Update the new
appsettings.Development.json
file to match your needs. - To run using Visual Studio, just start the app with/without debugging.
- To run through terminal,
- Navigate to
src/EmailService
- Set Environment Variable
* Windows:
set ASPNETCORE_ENVIRONMENT=Development
* Linux/macOS:export ASPNETCORE_ENVIRONMENT=Development
- Before your first run, execute
dotnet restore
- Execute
dotnet run
{{BaseUrl}}/swagger
will give information about the service endpoints.
For getting the project to run with Visual Studio Code, you will have to execute a few more steps:
- go to the Debug view and click the run button - you will be asked if a launch configuration should be created (click yes)
- in the created
tasks.json
, add the following line:"options": { "cwd": "${workspaceRoot}/src/EmailService" },
- in the created
launch.json
:- replace every occurence of
${workspaceRoot}
with${workspaceRoot}/src/EmailService
- add
"env": { "ASPNETCORE_ENVIRONMENT": "Development" }
to your run configurations
- replace every occurence of
- You can fork or clone our repo.
- To submit patches you should fork and then create a Pull Request
Please write an email to [email protected].
HiP (History in Paderborn) ist eine Plattform der: Universität Paderborn Warburger Str. 100 33098 Paderborn http://www.uni-paderborn.de Tel.: +49 5251 60-0
You can also write an email.