https://github.com/pranit-harekar/todo-app

Todo List API built using ASP.NET Core
https://github.com/pranit-harekar/todo-app

asp-net-core csharp docker entity-framework-core sql-server

Last synced: 12 days ago
JSON representation

Todo List API built using ASP.NET Core

• Host: GitHub
• URL: https://github.com/pranit-harekar/todo-app
• Owner: Pranit-Harekar
• Created: 2024-11-25T03:45:23.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-18T00:36:40.000Z (13 days ago)
• Last Synced: 2024-12-18T01:32:16.072Z (13 days ago)
• Topics: asp-net-core, csharp, docker, entity-framework-core, sql-server
• Language: C#
• Homepage:
• Size: 16.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Todo App - ASP.NET Core Backend Development

This repository is a practical demonstration of building robust and scalable backend applications using ASP.NET Core.

**Covered Concepts:**

- Implementing routes, redirects, custom middlewares, and endpoint filters

- Utilizing C# LINQ for data manipulation

- Leveraging dependency injection for loose coupling

- Connecting to relational databases

- Creating and applying version control code-first migrations

- Running migrations independently of container deployments

- Dockerizing the application

- Testing and documenting endpoints

**Technologies Used:**

- [ASP.NET Core 9.0](https://dotnet.microsoft.com/en-us/apps/aspnet)

- [Entity Framework Core 9](https://learn.microsoft.com/en-us/ef/core/)

- [MS SQL Server](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-overview?view=sql-server-ver16)

## Getting Started

This project is fully Dockerized for a quick and easy setup.

**Prerequisites:**

- .NET 9 SDK installed

- [Visual Studio Code with C# Dev Kit](https://code.visualstudio.com/docs/languages/dotnet)

  or [Visual Studio](https://visualstudio.microsoft.com/)

- [Docker Desktop](https://www.docker.com/products/docker-desktop/)

**Instructions:**

1. **Generate a [self-signed certificate](https://learn.microsoft.com/en-us/dotnet/core/additional-tools/self-signed-certificates-guide):**

   ```sh

   dotnet dev-certs https -ep ./https/TodoApi.pfx -p 

   ```

   Replace `` with a desired password.

2. **Set environment variables:**

   Rename `.env.example` to `.env` and configure the following:

   - `CERT_PASSWORD`: Use the password created in step 1.

   - `DB_PASSWORD`: Set your database password.

3. Start the application:

   Ensure Docker Desktop is running, then execute:

   ```sh

   make up

   ```

   View test requests in the [TodoApi.http](./TodoApi/TodoApi.http).

   Alternatively, access the simple web page at the below URLs.

   - HTTPS: https://localhost:7200

   - HTTP: http://localhost:5126

## Migrations

**Creating Migrations:**

1. Navigate to the [./TodoApi](/TodoApi) directory in your terminal.

2. Install the EF Core CLI if not yet available:

   ```sh

   dotnet tool install --global dotnet-ef

   ```

3. Update your data models as needed.

4. Replace `DB_CONNECTION_STRING` in `.env` file with the following:

   ```txt

   DB_CONNECTION_STRING="Server=localhost,1433;Database=TodoDb;User Id=SA;Password=${DB_PASSWORD};TrustServerCertificate=True;"

   ```

5. Generate a new migration:

   ```sh

   dotnet ef migrations add 

   ```

**Applying Migrations:**

Database migrations are automatically applied when the API container builds. To manually apply new migrations:

```sh

make db_migrate

```

## Next Steps

- Implement authentication

- Allow sharing of todos

- Document architecture

- Integrate Kubernetes

- Deploy to Azure

Feel free to create an issue if you have any questions or suggestions.

## License

MIT