An open API service indexing awesome lists of open source software.

https://github.com/sillsdev/overcrowdin

Overcrowdin is a dotnet CLI built on top of the Crowdin project crowdin-dotnet-client, which provides a .NET Api over the Crowdin REST API.
https://github.com/sillsdev/overcrowdin

Last synced: 4 months ago
JSON representation

Overcrowdin is a dotnet CLI built on top of the Crowdin project crowdin-dotnet-client, which provides a .NET Api over the Crowdin REST API.

Awesome Lists containing this project

README

          

## Overcrowdin - A dotnet Crowdin CLI

Crowdin is an amazing, popular, cloud-based localization management system.
It provides a CLI in Java, but that adds dependencies that many projects do not want. This project provides an alternative in the form of a .NET Core Global Tool.

**Overcrowdin** is a dotnet CLI built on top of the Crowdin project crowdin-dotnet-client, which provides a .NET Api over the Crowdin REST API.

This project is not yet feature complete with the Crowdin client. It was built to meet some immediate project needs and could be enhanced.

### Requirements

* .NET 8.0: To install and use Overcrowdin, you need .NET 8.0, which can be downloaded from Microsoft's website.

### Installation

Overcrowdin can be installed using the following command:
```dotnet tool install -g overcrowdin```

### Usage

After installation, ```overcrowdin``` will be available from the command prompt.

Overcrowdin uses a configuration file named ```crowdin.json``` in the working directory. This file follows the structure of Crowdin's YAML configuration file.

To see the program help, run ```overcrowdin``` with no options.

### FAQ

Q: Why don't you save the API Key in the configuration file?

A: I don't want to make it easy to commit secrets into a github repository so I encourage the environment variable option that Crowdin supports in their CLI.

### Developing Overcrowdin

#### Status
![Build Status]()
[![GitHub contributors](https://img.shields.io/github/contributors/sillsdev/overcrowdin?cacheSeconds=10000)](https://github.com/sillsdev/overcrowdin/graphs/contributors)
![Test coverage]()
[![GitHub](https://img.shields.io/github/license/sillsdev/overcrowdin)](https://github.com/sillsdev/overcrowdin/blob/master/LICENSE)

#### Developer Requirements
* .NET 8.0

#### Recommendations
* Visual Studio Community Edition 2022 or later

#### Cloning
```git clone https://github.com/sillsdev/overcrowdin```

Then you should be able to build the solution and run the unit tests
```
dotnet build
cd OvercrowdinTests
dotnet test
```