README.md
# eform-sdk-dotnet
[](https://www.nuget.org/packages/Microting.eForm/)
[](https://codeclimate.com/github/microting/eform-sdk-dotnet/maintainability)
[](https://www.codacy.com/gh/microting/eform-sdk-dotnet?utm_source=github.com&utm_medium=referral&utm_content=microting/eform-sdk-dotnet&utm_campaign=Badge_Grade)
A .NET SDK for integrating with the Microting eForm API v1.
## Supported Platforms
| OS | .Net Core 6.x | MySQL 5.5+ / MariaDB 10.4 |
| ------------- |:-----:|:-----:|
| OSX 13 | X | X |
| OSX 12 | X | X |
| OSX 11 | X | X |
| OSX 10.15.5 | X | X |
| OSX 10.14.2 | X | X |
| Ubuntu 22.04 | X | X |
| Ubuntu 20.04 | X | X |
| Ubuntu 19.04 | X | X |
| Ubuntu 18.04 | X | X |
| Ubuntu 16.04 | X | X |
| Windows 10 | X | X |
| Windows 11 | X | X |
## Setup
To get started with Microting eForm SDK, we recommend you to install the SDK using NuGet with
```
PM> Install-Package Microting.eForm
```
[We also recommend you to have a look at the reference Angular/C# web frontend](https://github.com/microting/eform-angular-frontend)
For implementing solutions using Microting.eForm we highly recommend that you use our angular-frontend and debian-service as foundation for your integration.
If you have any specific needs, please contact us or create an issue.
## Get access token
You need to create an account for Microting API and get your access credentials.
- Call Microting at +45 66 11 10 66 to get started.
## Docs
[NEW SDK documentation can be found here](https://docs.microting.com/sdk-documentation/introduction)
[old SDK documentation can be found here (beta)](https://microting.github.io/eform-sdk-documentation/?csharp#)
## Development recommendations
- Visual Studio 2017 / Rider
- MySQL 5.5+ / MariaDB 10.4
## Known bugs as of February 21st 2017
- The Core.TemplatFromXml(string xmlString) is not able to parse DataItems of the following types:
- EntitySearch
- EntitySelect
## Changelog
[Changelog](changelog.md)
## Contributing
1. Do a fork
2. Clone your fork onto your own computer
3. Checkout/create a new branch for your relevant issue
4. Apply your changes and tests
5. Commit your changes and push to github
6. Create a pull-request
### Pull requests
To enable us to quickly review and accept your pull requests, always create one pull request per issue and link the issue in the pull request. Never merge multiple requests in one unless they have the same root cause. Be sure to follow our coding guidelines and keep code changes as small as possible. Avoid pure formatting changes to code that has not been modified otherwise. Pull requests should contain tests whenever possible.
Pull-reuqsts that do not pass tests, will not be accepted.
### Where to contribute
Check out the [full issues list](https://github.com/microting/eform-sdk-dotnet/issues) for a list of all potential areas for contributions.
To improve the chances to get a pull request merged you should select an issue that is labelled with the [help_wanted](https://github.com/microting/eform-sdk-dotnet/issues?q=is%3Aissue+is%3Aopen+label%3Ahelp_wanted) or [bug](https://github.com/microting/eform-sdk-dotnet/issues?q=is%3Aissue+is%3Aopen+label%3Abug) labels. If the issue you want to work on is not labelled with `help-wanted` or `bug`, you can start a conversation with the issue owner asking whether an external contribution will be considered.
### Suggestions
We're also interested in your feedback for the future of Microting eForm SDK. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.
## Adding new migrations
Where MIGRATIONNAME is the name of the migration you want to create
```powershell
dotnet ef migrations add MIGRATIONNAME --project eFormCore/Microting.eForm.csproj --startup-project SourceCode/SourceCode.csproj --context MicrotingDbAnySQL
```
## Microting Open Source Code of Conduct
This project has adopted the [Microting Open Source Code of Conduct](https://www.microting.com/microting-open-source-code-of-conduct). Contact opencode@microting.com with any additional questions or comments.
## License
The MIT License (MIT)
Copyright (c) 2007-2020 microting
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
## Thanks to all contributors ❤
<a href = "https://github.com/microting/eform-sdk-dotnet/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=microting/eform-sdk-dotnet"/>
</a>