comissions-app-core-api/README.md

Comissions.app

Description

This is a application that provides a platform to allow creatives to sell their services without intense moderation.

Table of Contents

• Project Name
  • Description
  • Table of Contents
  • Prerequisites
  • Getting Started
    • Clone the Repository
    • Build and Run with Docker
  • Usage
  • Swagger UI
  • Contributing
  • License

Prerequisites

• .NET 8 SDK
• Docker

Getting Started

Clone the Repository

git clone https://github.com/D4M13N-D3V/art_platform
cd art_platform

Build and Run with Docker

Build the Docker image:

docker build -t art-platform -f ./src/ArtPlatform.API/Dockerfile --force-rm .

Run the Docker container:

docker run -p 8080:80 art-platform

The API should be accessible at http://localhost:8080.

Usage

Describe how to use your API and any specific details or considerations that users need to be aware of.

Swagger UI

The API is documented using Swagger UI. Once the application is running, you can access the Swagger UI at:

http://localhost:8080/swagger

This provides an interactive interface for testing and exploring your API endpoints.

Contributing

If you would like to contribute to the project, please follow the guidelines in CONTRIBUTING.md.

License

This project is licensed under the [License Name] - see the LICENSE.md file for details.