JoyModels API

REST API service for a Flutter 3D model marketplace application. It is built with .NET 8.0 and utilizes MariaDB and RabbitMQ.

• JoyModels API
  • Getting Started
    • Prerequisites
    • Initial Setup
    • Running with Docker
    • Credentials

Getting Started

Prerequisites

Before using the source code, ensure you have the following installed and configured

• .NET 8 SDK (Includes the ASP.NET Core Runtime)

Furthermore, you should have the following services running

• MariaDB Server
• RabbitMQ
• Docker (if you intend to run all of backend services inside docker containers)

Initial Setup

Clone the repository

git clone https://github.com/R3FA/joymodels-api.git

Running with Docker

To build the necessary images and run the provided compose.yaml, simply run the following command

docker compose up

Credentials

For test purposes, the API backend provides some test accounts for the client applications.

Warning: Root and Admin accounts can be used for desktop and mobile application, while regular accounts with user credentials are only for mobile application.

# Root account
Username: root1
Password: strinG1!

#Another root account
Username: root2
Password: strinG1!

# Admin account
Username: admin1
Password: strinG1!

# Another admin account
Username: admin2
Password: strinG1!

# Normal user account
Username: user1
Password: strinG1!

# Another normal user account
Username: user2
Password: strinG1!

# Another normal user account
Username: user3
Password: strinG1!

# Another normal user account
Username: user4
Password: strinG1!

Note: Check compose.yaml to set environment value for STRIPE_SECRET_KEY. It can be set with an .env file.