https://github.com/zulip/zulip-csharp
A C# library for the Zulip API
https://github.com/zulip/zulip-csharp
Last synced: 9 months ago
JSON representation
A C# library for the Zulip API
- Host: GitHub
- URL: https://github.com/zulip/zulip-csharp
- Owner: zulip
- License: mit
- Created: 2017-12-10T20:39:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T12:48:09.000Z (over 3 years ago)
- Last Synced: 2025-01-13T07:35:25.441Z (over 1 year ago)
- Language: C#
- Homepage:
- Size: 294 KB
- Stars: 15
- Watchers: 8
- Forks: 16
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zulip-csharp [](https://travis-ci.org/zulip/zulip-csharp)
ZulipCSharp is a library to connect to a Zulip server via API based on .NET Core
## Devlopment
Fork the repo, clone it and
then follow instructions per platform
Join us at [zulip chat ZulipAPI.NET stream](https://chat.zulip.org/#narrow/stream/ZulipAPI.2ENET)
### Windows and MacOS
If you haven't already downloaded these:
* [Visual Studio IDE](https://www.visualstudio.com/vs/)
* [node.js](https://nodejs.org/en/download/).
```
# download dependencies for local server
cd test-server
npm i
```
### Linux
Since Visual Studio IDE is not available for Linux we need
to get `dotnet core`. Node for test server.
- To get dotnet follow instructions here https://www.microsoft.com/net/download/linux, download the SDK
- To get node follow instructions here https://nodejs.org/en/download/
```
# build the project
# will output some error ignore it
./build-project
# to run tests
./run-tests
```
### Pull Request
commit messages should be formatted like below (present tense)
```
unit tests: add tests for file
(part of project): (summary of changes made)
```
Test the code. We use xUnit for testing.
Our test need a local server so install
dependencies in `test-server`
```bash
# start the server
# and then run tests using Visual Studio IDE
npm start
```
or to run test on command prompt / terminal
```
# on root directory
.\run-tests.cmd # for windows
./run-tests # for MacOS and linux
```
linting
```
npm run lint
# if you have common error use
npm run lint-fix
```