-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathReadMe
61 lines (41 loc) · 3.06 KB
/
ReadMe
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# TicketEase Project
TicketEase is a .NET 6 application designed to manage tickets and provide various services related to managing task activities. This project is organized into several distinct components, each serving a specific purpose within the application's architecture.
## Project Structure
### TicketEase
- **Controllers:** Contains the controllers responsible for handling various HTTP requests and responses.
- **Mapper:** Includes AutoMapper profiles for mapping between different data transfer objects (DTOs) and domain entities.
- **Configuration:** Contains extension methods for Swagger, IdentityService, MailService, LogSettings, and other configurations.
- **ConfigurationSetupExtension:** Extension methods for setting up and configuring the application.
- **AuthenticationServiceExtension:** Extensions related to the authentication service setup.
### TicketEase.Application
- **DTO:** Data transfer objects used for transferring data between layers.
- **Validators:** Validation logic for DTOs and other input data.
- **Interfaces:** Includes interfaces for repositories and services, defining contracts for the application.
- **ServiceImplementation:** Contains implementations for various services used within the application.
### TicketEase.Common
- **Utilities:** Helper classes such as Pagination and DateTime Formatter that are shared across different parts of the application.
### TicketEase.Domain
- **Entities:** Domain entities representing the core business objects within the application.
- **Enums:** Enumerations used within the domain.
### TicketEase.Persistence
- **Contexts:** Contains the DbContext class, which represents the database context for the application.
- **Repositories:** Includes all repositories responsible for data access and manipulation.
- **Extensions:** Database configurations and dependency injection registrations.
## Getting Started
To get started with the TicketEase project, follow the steps below:
1. Clone the repository to your local machine.
2. Ensure you have .NET 6 SDK installed.
3. Open the solution file in your preferred IDE.
4. Configure the database connection in the `appsettings.json` file.
5. Run the database migrations using the Entity Framework Core CLI tools.
6. Build and run the application.
# Creating a Pull Request
Follow these steps to create a pull request for the TicketEase project:
1. **Pull Latest Changes:** Pull the latest changes from the remote 'develop' branch to your local branch:
git pull origin develop
2. Resolve Merge Conflicts: If there are any merge conflicts, resolve them on your local machine using a code editor or a merge tool.
3. Clean and Build: Ensure that the project solution builds successfully
4. Git Add: Add the changes you want to commit
5. Git Commit: Commit the changes with a descriptive commit message
6. Git Push: Push the changes to your forked repository
7. After following these steps, you can proceed to create a pull request from your repository to the develop branch. Make sure to provide a clear and concise description of the changes you've made in the pull request.