Skip to content

kleqing/BandCommunity-Back-end

Repository files navigation

Band Community Back-end

Back-end version of Band Community

For front-end version, please visit BandCommunity-Front-end

Table of content

Installation

The project required .NET SDK 8

// Install dotnet ef core (If already installed, skip this section)
dotnet tool install --global dotnet-ef

Usage

# Clone the repository
git clone https://github.com/kleqing/BandCommunity-Back-end

Before run the application, make sure you have config the .env file first. The file is locate at BandCommunity.WebApi/.env.template

// Restore project
dotnet restore

// Build project
dotnet build

// Create database from model (required dotnet ef core)
dotnet ef migrations add "Initial" --project BandCommunity.Infrastructure  --startup-project BandCommunity.WebApi --context ApplicationDbContext
dotnet ef database update --project BandCommunity.Infrastructure  --startup-project BandCommunity.WebApi --context ApplicationDbContext 

// API Endpoint: https://localhost:7160/swagger/index.html

Project Structure

├── Application
│   ├── Common // Response data
│   └── Services // Services for the application
│       ├── Auth 
│       ├── Email 
│       └── Role 
├── Domain
│   ├── DTO // Request data
│   │   └── Auth 
│   ├── Entities // Entities of the system
│   ├── Enums 
│   ├── Interfaces // Inheritors from Infrastructure.Repositories
│   ├── JWT // Json Web Token
│   └── Models // Custom request/response data
│       └── Auth
├── Infrastructure
│   ├── Auth // Interfaces of Application.Services
│   ├── Data // DbContext
│   ├── Migrations 
│   └── Repositories // Repository 
├── Shared
│   ├── Constant
│   ├── Exceptions // Throw exception messages
│   ├── Helper 
│   └── Utility
└── WebApi
    ├── Controller
    ├── .env // Configuration
    └── Program.cs

Environment

  • PostgreSQL 17
  • Jetbrains Rider (Other IDE still work)
  • TablePlus (SQL Management)

NOTE: IF YOU PREFER TO USE OTHER SQL THAN POSTGRE, PLEASE REMOVE POSTGRESQL PACKAGE IN THE PROJECT AND USE YOUR OWN!

License

This project is licensed under the MIT License

About

Back-end of Band Community project

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages