| BRANCH | AZURE PIPELINES | TESTS | CODE COVERAGE |
|---|---|---|---|
| MASTER |  |
The project is used to undertake third-party services and verify the legitimacy of CAServer users.The project is developed based on the ABP framework, using the Orleans framework, with Grain as the application's business logic implementation and abstraction, and Silo as the host service.Implementation includes verification code services, third-party login (Google, Apple account), and other functions.
Before cloning the code and running the project, you need to install the following dependencies:
- Dotnet7.0+
- Mongodb
- Redis
- Nginx
The following command will clone Portkey DID Verifier Server code into a folder. Please open a terminal and enter the following command:
git clone https://github.com/Portkey-Wallet/portkey-DID-verifierThe next step is to build the project to ensure everything is working correctly. Once everything is built, you can run as follows:
# enter the Launcher folder and publish
dotnet publish
you should startup your mongodb and redis server before you run the project.And then you should first startup the Silo Module and then startup the HttpApi.Host Module.
You can easily run unit tests on the project using the following command under the Launcher folder:
dotnet testThe Portkey Contract provides the following modules:
CAVerifierServer.Application: Business logic processing module.CAVerifierServer.Application.Contracts: Interface definition module.CAVerifierServer.AuthServer: Authentication Service Module.CAVerifierServer.DbMigrator: Data initialization moduleCAVerifierServer.Grains: Grain processing data moduleCAVerifierServer.EntityEventHandler: Event driven module.CAVerifierServer.HttpApi: HttpApi module.
After starting the service, you can access Swagger at the following address: http://localhost:5577/swagger/index.html Due to the use of a whitelist mechanism in the project, you need to create a whitelist in Nginx's' X-Forwarded For '. If you are using a local environment, you can directly configure your IP address to the whitelist in order to access the interface, or comment out the whitelist interception middleware configuration in the startup class. This way, you can access Swagger and access the interface normally.
We welcome contributions to the Portkey DID Verifier Server project. If you would like to contribute, please fork the repository and submit a pull request with your changes. Before submitting a pull request, please ensure that your code is well-tested and adheres to the aelf coding standards.
Portkey DID Verifier Server is licensed under MIT.
If you have any questions or feedback, please feel free to contact us at the Portkey community channels. You can find us on Discord, Telegram, and other social media platforms.
Links:
- Website: https://portkey.finance/
- Twitter: https://twitter.com/Portkey_DID
- Discord: https://discord.com/invite/EUBq3rHQhr