From 180bfbc3d42beaf2b11c51f47ad2444a5f43a4fb Mon Sep 17 00:00:00 2001 From: cuqmbr <52876496+cuqmbr@users.noreply.github.com> Date: Sun, 17 Jul 2022 22:09:59 +0300 Subject: [PATCH] docs: add README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3db1671 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# scoreboard-api – CRUD API with authetcication and authorization + +## Features + +- Register a user account +- Log in to registered account +- Create scoreboard record using registered account +- Retrieve full scoreboard +- Retrieve a user's highscore by username +- Update scoreboard record using administarator's account +- Delete scoreboard record using administartor's account + +## Project preview + +
+ Search route page +
+ +## How to install? + +1. [Download](https://dotnet.microsoft.com/download) and install .NET with ASP.NET Core +2. Clone this project +3. Install Entity Framework Core .NET Command-line Tools `[~]$ dotnet tool install --global dotnet-ef` +4. Update(by default create new SQLite) database `[~/Server]$ dotnet ef database update` +5. Compile and deploy + +## How to tweak this project for your own uses? + +- You can change database provider by installing corresponding NuGet packages and changing connection string + +## How to contribute? + +If you want to add a feature, you should follow these steps: + +1. Fork the project +2. Make some changes and commit them with [conventional commit message](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/) +3. Submit a PR with a new feature/code + +## Find a bug? + +If you found an issue or would like to submit an improvement to this project, please submit an issue using the issues tab above. If you would like to submit a PR with a fix, reference the issue you created!