Skip to content

Commit bfc5006

Browse files
authored
Update README.md
1 parent 7417993 commit bfc5006

File tree

1 file changed

+66
-10
lines changed

1 file changed

+66
-10
lines changed

README.md

Lines changed: 66 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,76 @@
1-
# Full Stack React Application for Event Management
1+
# Full Stack Event Management System
22

3-
## Introduction
4-
This is a full stack application for managing events. It allows users to create, update, and delete events. The application also supports user authentication and provides a responsive design to ensure a great user experience on both desktop and mobile devices.
3+
## Overview
4+
5+
This repository contains a full-stack Event Management System developed as part of a comprehensive course on ASP.NET Core and React. The application demonstrates key features for managing events, user interactions, and real-time updates.
56

6-
The back-end is powered by asp.net core, and the front-end is built using React. The project is connected to a database for storing and retrieving event details.
77
## Features
8-
* User authentication (sign up, login, logout)
9-
* Create, update, and delete events
10-
* View all upcoming events
11-
* Responsive design
12-
* Integrated with a database for persistent storage
8+
9+
- **User Authentication and Authorization**: Secure user login and role-based access control.
10+
- **Event Management**: Users can create, follow, and unfollow events with ease.
11+
- **Social Features**: Includes a user follow/unfollow system to foster interaction.
12+
- **Real-Time Communication**: Integrated real-time commenting functionality using SignalR.
13+
- **CI/CD Pipeline**: Automated deployment to Azure via GitHub Actions ensures a streamlined release process.
14+
15+
## Technologies Used
16+
17+
- **Front-End**: React, React Hooks, Redux.
18+
- **Back-End**: ASP.NET Core, SignalR.
19+
- **Cloud**: Azure for hosting and deployment.
20+
- **Tools**: GitHub Actions for CI/CD, Webpack for module bundling.
21+
22+
## How to Run the Project
23+
24+
1. Clone the repository:
25+
```bash
26+
git clone https://github.com/your-username/event-management-system
27+
```
28+
2. Navigate to the project directory:
29+
```bash
30+
cd event-management-system
31+
```
32+
3. Install front-end dependencies:
33+
```bash
34+
cd client
35+
npm install
36+
```
37+
4. Install back-end dependencies:
38+
```bash
39+
cd ../server
40+
dotnet restore
41+
```
42+
5. Run the back-end server:
43+
```bash
44+
dotnet run
45+
```
46+
6. Run the front-end client:
47+
```bash
48+
cd ../client
49+
npm start
50+
```
51+
7. Open the application in your browser at `http://localhost:3000`.
52+
53+
## Skills Demonstrated
54+
55+
- **Full-Stack Development**: ASP.NET Core and React integration.
56+
- **Real-Time Functionality**: SignalR for real-time communication.
57+
- **Testing and CI/CD**: Implemented automated workflows and deployments with GitHub Actions.
58+
- **Cloud Hosting**: Deployed to Azure for reliable and scalable hosting.
59+
-
1360
## Technologies Used
14-
* Front-end: React, JavaScript, CSS
61+
* Front-end: React18, Typescript, CSS, Bootstrap
1562
* Back-end: ASP.NET Core, C#
1663
* Database: SQL Azure
1764
* Version Control: Git
1865
* API Testing: Postman
66+
## Contact
67+
68+
For any questions or collaboration opportunities, feel free to contact me:
69+
70+
- **Email**: Ira.varshavsky@gmail.com
71+
- **LinkedIn**: [Ira Varshavsky](https://www.linkedin.com/in/Ira-Varshavsky)
72+
73+
74+
1975
## Notes
2076
Please note that this is a learning project intended for educational purposes. While it includes core functionality for managing events, it may not cover advanced features or optimizations found in production-ready applications.

0 commit comments

Comments
 (0)