Skip to content

Commit

Permalink
updated the readme to some text generated by chatgpt
Browse files Browse the repository at this point in the history
  • Loading branch information
DustSwiffer committed Jul 18, 2024
1 parent e0bb940 commit 8210ca1
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# API Boilerplate

This repository provides a boilerplate for creating a fully functional API using .NET technologies. It includes the setup for StyleCop, Entity Framework Core (EF Core), Swagger UI, AutoFixture, and Moq. The solution is structured with separate projects for Business Logic, Data Access, and API Endpoints to promote clean architecture and maintainability.

## Table of Contents

- [Features](#features)
- [Project Structure](#project-structure)
- [Getting Started](#getting-started)
- [Configuration](#configuration)
- [Usage](#usage)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)

## Features

- **StyleCop**: Enforces consistent code style and quality.
- **EF Core**: Simplifies database operations.
- **Swagger UI**: Provides interactive API documentation.
- **AutoFixture**: Automates the generation of test data.
- **Moq**: Facilitates the creation of mock objects for unit testing.

## Project Structure

The solution is divided into three main projects:

1. **API**: Contains the endpoints and configurations for the API.
2. **Business**: Contains the business logic and services.
3. **Data**: Contains the data models, context, and repository implementations.

0 comments on commit 8210ca1

Please sign in to comment.