Skip to content

Commit b255cf7

Browse files
Updating README.md File with new Project especifications.
1 parent 2eb92b0 commit b255cf7

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@
55

66
This project is a .NET application that interacts with the Ticketmaster API to fetch and display information about attractions and events. The application includes models for attractions, events, and images, and services to handle API requests and responses.
77

8+
## App Features
9+
10+
### Key Features Highlight
11+
12+
- **Search Bar: Enables users to search for attractions using the Ticketmaster API.
13+
- **Attractions List: Dynamically shows results from the search query with visual cards.
14+
- **Attraction Details: Displays details of selected attractions, including upcoming events.
15+
- **Responsive UI: Optimized for mobile and desktop using Bootstrap.
16+
- **Blazor Components: Efficient use of Blazor components for reusability and clean code structure.
17+
818
## Necessary Tools and Frameworks
919

1020
- **.NET 8.0 SDK**: The project is built using .NET 8.0.
@@ -87,7 +97,7 @@ This project is a .NET application that interacts with the Ticketmaster API to f
8797
- **Dockerfile**
8898
- `Dockerfile` is used to build a Docker image for the application. It copies the application files, restores the dependencies, and builds the application.
8999

90-
## Steps to Deploy the Solution
100+
## Steps to Deploy the Solution Locally.
91101

92102
1. **Clone the Repository**
93103

@@ -110,6 +120,24 @@ This project is a .NET application that interacts with the Ticketmaster API to f
110120
7. **Run the Application**
111121
Run the application by clicking on `Debug` > `Start Debugging` or pressing `F5`.
112122

123+
## Continious Integration and Continious Deployment(CI/CD).
124+
125+
This project is configured for Continuous Integration (CI) and Continuous Deployment (CD) using GitHub Actions. Whenever changes are pushed to the `development` branch, the CI pipeline runs tests(There is no Tests in the project due to its simplicity) and builds the project. When changes are merged into the `master` branch, the application is automatically deployed to Azure App Service.
126+
127+
- **Deployment Service**: Azure App Service
128+
- **Deployment Method**: GitHub Actions
129+
- **App URL**: (https://blazorticketmasterapp.azurewebsites.net/)
130+
131+
### Continuous Integration (CI)
132+
133+
1. **Configure GitHub Actions for CI**:
134+
- Ensure you have a `.github/workflows` directory in your repository.
135+
- Add a workflow YAML file (`master_blazorticketmasterapp.yml`) to define the CI process.
136+
137+
2. **Configure Azure App Service Deployment Center**:
138+
- An Azure App Service is required to deploy the application.This was done manually in the Azure Portal.
139+
- In `Deployment Center` > `GitHub`, the deployment source and branch were configured.
140+
113141
## Logging
114142

115143
The application uses `ILogger` for logging HTTP client configurations, API responses, and errors. Logs can be viewed in the Output pane of Visual Studio.

0 commit comments

Comments
 (0)