You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-20Lines changed: 41 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
Plug-n-play implementation of `IResourceRepository<TResource, TId>` allowing you to use [MongoDB](https://www.mongodb.com/) with your [JsonApiDotNetCore](https://github.com/json-api-dotnet/JsonApiDotNetCore) APIs.
- JSON:API relationships are currently not supported. You can use complex object graphs though, which are stored in a single document.
93
+
94
+
## Contributing
95
+
96
+
Have a question, found a bug or want to submit code changes? See our [contributing guidelines](https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/.github/CONTRIBUTING.md).
97
+
98
+
## Trying out the latest build
99
+
100
+
After each commit to the master branch, a new prerelease NuGet package is automatically published to AppVeyor at https://ci.appveyor.com/nuget/jsonapidotnetcore. To try it out, follow the next steps:
* Open the NuGet package manager console (**Tools**, **NuGet Package Manager**, **Package Manager Console**)
107
+
* Select **AppVeyor JADNC MongoDb** as package source
108
+
* Run command: `Install-Package JonApiDotNetCore -pre`
109
+
89
110
## Development
90
111
91
-
Restore all NuGet packages with:
112
+
To build the code from this repository locally, run:
92
113
93
114
```bash
94
-
dotnet restore
115
+
dotnet build
95
116
```
96
117
97
-
### Testing
98
-
99
-
You don't need to have a running instance of MongoDB on your machine. To run the tests just type the following command in your terminal:
118
+
You don't need to have a running instance of MongoDB on your machine to run tests. Just type the following command in your terminal:
100
119
101
120
```bash
102
121
dotnet test
@@ -105,15 +124,17 @@ dotnet test
105
124
If you want to run the examples and explore them on your own **you are** going to need that running instance of MongoDB. If you have docker installed you can launch it like this:
106
125
107
126
```bash
108
-
docker run -p 27017:27017 -d mongo:latest
127
+
run-docker-mongodb.ps1
109
128
```
110
129
111
130
And then to run the API:
112
131
113
132
```bash
114
-
dotnet run
133
+
dotnet run --project src/Examples/GettingStarted
115
134
```
116
135
117
-
## Limitations
136
+
Alternatively, to build and validate the code, run all tests, generate code coverage and produce the NuGet package:
0 commit comments