This project is a Rest API that serves as a backend for any chat app YOU feel like making. Written with only C#, this program runs fast and gives you complete control over your data. Not only that, but it also includes and allows you to do all of the following:
- Create user accounts with passwords hashed securely and stored in an SQLite database
- Request JWTs from server to provide secure authentication when logging in from a client
- Create conversations to connect users with one another
- Send messages between users through conversations
- Manage user and conversation objects: rename and delete as needed
- Swagger UI for testing API functionality
- Fast database access through Microsoft's EntityFrameworkCore
- Asynchronous server calls to allow multiple client requests to be handled simultaneously
- Go to https://dotnet.microsoft.com/en-us/download and download the .NET SDK, or
run
sudo apt-get install dotnet8on Linux. - Clone this repository.
- Open a terminal session in your clone of this project and run
dotnet buildto compile project assets and download dependencies. - Run
dotnet runto run this project on a localhost. - Run
dotnet publishto publish this project into a deployable folder/docker container.
See more on the .NET CLI at https://learn.microsoft.com/en-us/dotnet/core/tools/
- Install .NET CLI (Instructions above).
- Open .NET CLI at this project's root.
- Install the dotnet-ef tool for running EntityFramework database migrations with
dotnet tool install --global dotnet-ef - Update/setup the database with
dotnet ef database update
Without making these changes, you will not be able to save any data to the development database while in the development launch configuration.
This API is meant to be simple, so that you can get started with using it right away. If you would like to add new features, feel free to fork this repository or submit a pull request.