README.md

CookieBook-WebAPI

This is a WebAPI for Cookie Book project. This project is a cookbook system where users can add, share, rate and comment other's culinary recipes.

It's responsible for the server side of the project: storing, modifying and returning data. It follows the rules of the RESTfull API.

Table of contents

• Technologies
• Launch
• Scope of functionalities
• Project status

Technologies

• .NET Core 2.1
• Entity Framework Core 2.1.1
• Microsoft SQL Server 2017
• Fluent Validation 8.0.0-preview3

Launch

1. Download this project/repository.
2. Download and install:
   • .NET Core 2.1 Runtime
   • Microsoft SQL Server 2017
3. Go to the CookieBook-WebAPI\CookieBook.WebAPI and run Powershell/Command Promp/Terminal in this location.
4. Type dotnet ef database update. This will create the database and apply all migrations.
5. Type dotnet run. This will run the WebAPI.
6. You can now work with this WebAPI.

Scope of functionalities

Functionality	Status
User registration	✔️
User loging in	✔️
Updating user data	✔️
Changing user password	✔️
Adding cooking recipe	✔️
Adding category	✔️
Updating category	✔️
Updating cooking recipe	✔️
Cooking recipes ratting	✔️
Restoring account access	✔️
Statistics for admin	✔️

Project status

Current status: DONE ✔️

Application is before it's first release.

A Master branch is always the stable one. If you are intrested in testing the project in its current form then you should download this branch.