mirror of
https://github.com/bitwarden/server.git
synced 2024-11-21 12:05:42 +01:00
more build/run instructions
This commit is contained in:
parent
3621699f9d
commit
a8e5b444e2
35
README.md
35
README.md
@ -5,16 +5,43 @@
|
||||
|
||||
The bitwarden Core project contains the APIs, database, and other infrastructure items needed for the "backend" of all other bitwarden projects.
|
||||
|
||||
The core infrastructure is written in C# using .NET with ASP.NET Core. The database is SQL Server.
|
||||
The core infrastructure is written in C# using .NET Core with ASP.NET Core. The database is written in T-SQL/SQL Server.
|
||||
|
||||
The codebase can be developed, built, run, and deployed cross-platform on Windows, macOS, and Linux distributions.
|
||||
|
||||
# Build/Run
|
||||
|
||||
**Requirements**
|
||||
|
||||
- [ASP.NET Core](https://dot.net)
|
||||
- Recommended: [Visual Studio](https://www.visualstudio.com/)
|
||||
- [.NET Core 2.x](https://dot.net)
|
||||
- [SQL Server 2016 or 2017](https://docs.microsoft.com/en-us/sql/index)
|
||||
|
||||
Open `bitwarden-core.sln`. After restoring the nuget packages, you can build and run the `Api` project.
|
||||
**Recommended tooling**
|
||||
|
||||
- [Visual Studio](https://www.visualstudio.com/vs/) (Windows and macOS)
|
||||
- [Visual Studio Code](https://code.visualstudio.com/) (other)
|
||||
|
||||
**API**
|
||||
|
||||
```
|
||||
cd src/Api
|
||||
dotnet restore
|
||||
dotnet build
|
||||
dotnet run -f netcoreapp2.0
|
||||
```
|
||||
|
||||
visit http://localhost:5000/alive
|
||||
|
||||
**Identity**
|
||||
|
||||
```
|
||||
cd src/Identity
|
||||
dotnet restore
|
||||
dotnet build
|
||||
dotnet run -f netcoreapp2.0
|
||||
```
|
||||
|
||||
visit http://localhost:33657/.well-known/openid-configuration
|
||||
|
||||
# Contribute
|
||||
|
||||
|
@ -15,10 +15,10 @@
|
||||
"ASPNETCORE_ENVIRONMENT": "Development"
|
||||
}
|
||||
},
|
||||
"Web": {
|
||||
"Api": {
|
||||
"commandName": "Project",
|
||||
"launchBrowser": false,
|
||||
"launchUrl": "http://localhost:5000",
|
||||
"launchBrowser": true,
|
||||
"applicationUrl": "http://localhost:5000",
|
||||
"environmentVariables": {
|
||||
"ASPNETCORE_ENVIRONMENT": "Development"
|
||||
}
|
||||
|
@ -16,12 +16,12 @@
|
||||
}
|
||||
},
|
||||
"Identity": {
|
||||
"commandName": "Identity",
|
||||
"launchBrowser": false,
|
||||
"commandName": "Project",
|
||||
"launchBrowser": true,
|
||||
"applicationUrl": "http://localhost:33657",
|
||||
"environmentVariables": {
|
||||
"ASPNETCORE_ENVIRONMENT": "Development"
|
||||
},
|
||||
"applicationUrl": "http://localhost:33657"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user