City-Discover-Tourist-Server

Introduction

City-Discover-Tourist-Server

📒 Index

• About
• Usage
  • Installation
  • Commands
• Development
  • Pre-Requisites
  • Developmen Environment
  • File Structure
  • Build
  • Deployment
• Community
  • Contribution
  • Guideline
• Resources
• Credit/Acknowledgment
• License

🔰 About

• An API server for a platform that allows tourists to buy Quests designed by experienced people. Quests are self-guided tours combined with interesting puzzle games on the trip.

⚡ Usage

🔌 Installation

📦 Commands

• Commands to start the project.

git clone https://github.com/CityDiscoverTourist/CityDiscoverTouristServer.git
dotnet restore
dotnet build -c Release
dotnet dotnet test -c Release --no-build --verbosity normal
dotnet run

🔧 Development

📓 Pre-Requisites

List all the pre-requisites the system needs to develop this project.

• MSSQL
• Dotnet runtime
• IDE

🔩 Development Environment

Write about setting up the working environment for your project.

• How to download the project...
• How to install dependencies...

📁 File Structure

Add a file structure here with the basic details about files, below is an example.

.
├── CityDiscoverTourist.API
│   ├── AWS
│   ├── Cache
│   ├── Config
│   │    ├── ConfigController.cs
│   │    ├── ConfigDatabase.cs
│   │    └── ConfigFirebase.cs
│   ├── Controllers
│   │    ├── AuthController.cs
│   │    ├── ContactController.cs
│   │    └── etc
│   ├── Response
│   │    └── ApiResponse.cs
│   ├── appsettings.json
│   ├── Program.cs
│   └── .gitignore
├── CityDiscoverTourist.Business
│   ├── Data
│   │   ├── RequestModel
|   │   │   ├── QuestRequestModel.cs
|   |   |   └── etc
│   │   ├── ResponseModel
|   │   │   ├── QuestResponseModel.cs
|   |   |   └── etc
│   │   └── AutoMapperProfile.cs
│   ├── Enum
│   ├── Exceptions
│   ├── Helper
│   │   ├── EmailHelper
│   │   ├── Params
|   │   │   ├── QueryStringParams.cs
|   │   │   ├── QuestParams.cs
|   │   │   └── etc
│   │   ├── ISortHelper.cs
│   │   ├── PageList.cs
│   │   └── SortHelper.cs
│   ├── IService
│   │   ├── Service
|   │   │   ├── AuthService.cs
|   │   │   ├── QuestService.cs
|   │   │   └── etc
│   │   ├── IAuthService.cs
│   │   ├── IQuestService.cs
│   │   └── etc
│   ├── Settings
│   └── .gitignore
├── CityDiscoverTourist.Data
│   ├── IRepositories
│   │   ├── Repositories
|   │   │   ├── IAnswerRepository.cs
|   │   │   └── etc
│   ├── Migrations
│   ├── Models 
│   ├── .gitignore 
├── CityDiscoverTourist.Test
└── README.md

🔨 Build

dotnet build -c Release

🚀 Deployment

Write the deployment instruction here.

🔥 Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

📄 Resources

Add important resources here

🌟 Credit/Acknowledgment

Contributors

🔒 License

License under the MIT LICENSE