Skip to content
This repository has been archived by the owner on Oct 12, 2021. It is now read-only.

Commit

Permalink
Updated README and documentation-rs
Browse files Browse the repository at this point in the history
  • Loading branch information
DaniloNovakovic committed Sep 11, 2020
1 parent cfca898 commit 57c37e1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

[![Build Status](https://dev.azure.com/dakenzi97/ApartmentReservations/_apis/build/status/apartment-reservation%20-%20CI?branchName=master)](https://dev.azure.com/dakenzi97/ApartmentReservations/_build/latest?definitionId=3&branchName=master)

Apartment Reservation is a school project, built using ASP.NET Core, Entity Framework Core and React.
Apartment Reservation is a school project, built using ASP.NET Core, Entity Framework Core, MongoDB.Driver and React.

![Reservation Demo](doc/reservation-demo.gif)

## Getting Started

Use these instructions to get the project up and running.

> Note: Application is currently not working properly on `Microsoft Edge` browser due to the it's [bug with `fetch`](https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/18775440/) so it is advisable to use `Google Chrome` or `Mozilla Firefox` instead until this issue is resolved.
> Note: Application may not work properly on some versions of `Microsoft Edge` browser due to it's [bug with `fetch`](https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/18775440/)
### Prerequisites

Expand All @@ -19,6 +19,7 @@ You will need the following tools:
* [Visual Studio 2017-2019](https://www.visualstudio.com/downloads/)
* [.NET Core SDK 2.1](https://www.microsoft.com/net/download/dotnet-core/2.1)
* [NPM](https://nodejs.org/en/)
* (Optional) [MongoDB](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/) - this is only if you wish to run it locally (*default connection string*)

### Setup

Expand All @@ -27,17 +28,19 @@ Follow these steps to get your development environment set up:
1. Clone the repository
1. Go to `ApartmentReservation.WebUI/ClientApp` directory and run: `npm install`
1. Build solution in Visual Studio (2017 or 2019)
1. (Optional) Modify connection strings in `ApartmentReservation.WebUI/appsettings.json`
1. Start Application with `ApartmentReservation.WebUI` set as your StartUp Project

## Technologies

* .NET Core 2.1
* ASP.NET Core 2.1
* Entity Framework Core 2.1
* MongoDB.Driver 2.11
* React 16.8

## API Doc

Swagger API Doc can be found on `/swagger` or `/redoc` route.

More detailed documentation (currently only in Serbian language) can be found can be found [here](doc/documentation-rs.pdf).
More detailed documentation (currently only in Serbian language) can be found can be found [here](doc/documentation-rs.pdf)
Binary file modified doc/documentation-rs.pdf
Binary file not shown.

0 comments on commit 57c37e1

Please sign in to comment.