Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove ApiServer Readme #239

Merged
merged 2 commits into from
Sep 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 1 addition & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ Machine is available as a set of NuGet packages:
- [SIL.Machine](https://www.nuget.org/packages/SIL.Machine/): core library
- [SIL.Machine.Translation.Thot](https://www.nuget.org/packages/SIL.Machine.Translation.Thot/): statistical machine translation and word alignment
- [SIL.Machine.Morphology.HermitCrab](https://www.nuget.org/packages/SIL.Machine.Morphology.HermitCrab/): rule-based morphological parsing
- [SIL.Machine.WebApi](https://www.nuget.org/packages/SIL.Machine.WebApi/): ASP.NET Core web API middleware

Machine is also available as a command-line tool that can be installed as a .NET tool.

Expand All @@ -102,21 +101,4 @@ If you would like to find out more about how to use Machine, check out the tutor

### CSharpier

All C# code should be formatted using [CSharpier](https://csharpier.com/). The best way to enable support for CSharpier is to install the appropriate [IDE extension](https://csharpier.com/docs/Editors) and configure it to format on save.

### Development locally

- Install MongoDB 6.0 and MongoDBCompass and run it on localhost:27017
- Create the following folders:
- C:\var\lib\machine\data
- C:\var\lib\machine\machine
- set the following environment variables:
- ASPNETCORE_ENVIRONMENT=Development
- Open "Machine.sln" and debug the ApiServer
- Now, you are running the complete environment where everything is being debugged and the mongodb is exposed.

### Develop with serval

* Install https://github.com/sillsdev/serval in an adjacent folder
* Follow the instructions in serval for develoment
* To debug machine and machine_job together, launch "DockerComb" in VSCode
All C# code should be formatted using [CSharpier](https://csharpier.com/). The best way to enable support for CSharpier is to install the appropriate [IDE extension](https://csharpier.com/docs/Editors) and configure it to format on save.
Loading