Skip to content

Commit dff50c7

Browse files
committed
feat: add client-deployment.md
1 parent 5605d65 commit dff50c7

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

docs/client-deployment.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# ByteSync Client Deployment Documentation
2+
3+
## Technology and Requirements
4+
5+
These projects are written in **C#** and target a specific version of **.NET**. You can find the exact .NET version required by checking the `.csproj` file of the **ByteSync.Client** project. You must have the appropriate .NET SDK installed to build and deploy the solution.
6+
7+
## Cloning and Building from Source
8+
9+
1. **Clone the Repository**:
10+
11+
```bash
12+
git clone https://github.com/POW-Software/ByteSync.git
13+
```
14+
15+
Navigate to the `ByteSync.Client` folder if needed.
16+
17+
2. **Open the C# Project**:
18+
19+
- Open the `.sln` (solution) file in Visual Studio or Visual Studio Code.
20+
- Verify that the .NET version specified in the `.csproj` is installed on your system.
21+
22+
3. **Create `local.settings.json`** at the project root. Example content:
23+
24+
```json
25+
{
26+
"LocalDebugUrl": "",
27+
"DevelopmentUrl": "",
28+
"StagingUrl": "",
29+
"ProductionUrl": "",
30+
"UpdatesDefinitionUrl": ""
31+
}
32+
```
33+
34+
Fill in any relevant URLs or other settings your environment requires.
35+
36+
4. **Build the Project**:
37+
38+
- Use the command line:
39+
```bash
40+
dotnet build
41+
```
42+
- Or build directly through Visual Studio / VS Code.
43+
44+
5. **Run the Client**:
45+
46+
```bash
47+
dotnet run
48+
```
49+

0 commit comments

Comments
 (0)