Skip to content

Commit 9c57f4b

Browse files
Update README.md
1 parent 7d60ae5 commit 9c57f4b

File tree

1 file changed

+68
-1
lines changed

1 file changed

+68
-1
lines changed

README.md

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Eventify Frontend
22

3-
The frontend for **Eventify** is built using Angular to provide a dynamic user interface for our Event Management System. This repository contains all the source code and assets needed for the frontend application.
3+
The front end for **Eventify** is built using Angular to provide a dynamic user interface for our Event Management System. This repository contains all the source code and assets needed for the frontend application.
44

55
## Technologies Used
66

@@ -32,6 +32,73 @@ Eventify-Frontend/
3232
├── package.json # Project metadata and dependencies
3333
└── README.md # Project documentation
3434
```
35+
36+
## How to Run the Application
37+
38+
Follow these steps to set up and run the application:
39+
40+
### 1️⃣ Clone the Repository
41+
```bash
42+
git clone https://github.com/XoCode-Software-development-team/Eventify-event_management_system-frontend
43+
cd Eventify-event_management_system-frontend
44+
```
45+
46+
### 2️⃣ Install Dependencies
47+
```bash
48+
npm install
49+
```
50+
51+
### 3️⃣ Set Up Firebase Cloud Storage
52+
- Configure Firebase in your project.
53+
- Obtain your Firebase credentials from the Firebase console.
54+
55+
### 4️⃣ Get a Google Maps API Key
56+
To use Google Maps in your application, follow these steps to obtain an API key:
57+
58+
1. Go to the [Google Cloud Console](https://console.cloud.google.com/).
59+
2. Create a new project or select an existing one.
60+
3. Navigate to **APIs & Services > Credentials**.
61+
4. Click **Create Credentials** > **API Key**.
62+
5. Enable the following APIs for your project:
63+
- **Maps JavaScript API**
64+
6. Copy the generated API key.
65+
66+
### 5️⃣ Create `environment.ts`
67+
- Navigate to the `environments/` directory.
68+
- Create a new file named `environment.ts`.
69+
- Copy the structure from `example.environment.ts` and update the credentials.
70+
71+
#### Example `environment.ts` File:
72+
```typescript
73+
export const baseApiUrl = {
74+
Url: 'your-api-url'
75+
};
76+
77+
export const environment = {
78+
firebaseConfig: {
79+
apiKey: "your-firebase-apiKey",
80+
authDomain: "your-authDomain",
81+
projectId: "your-projectId",
82+
storageBucket: "your-storageBucket",
83+
messagingSenderId: "your-messagingSenderId",
84+
appId: "your-appId",
85+
measurementId: "your-measurementId"
86+
}
87+
};
88+
89+
export const mapEnvironment = {
90+
production: false,
91+
googleMapsApiKey: 'your-googleMapAPIKey'
92+
};
93+
```
94+
95+
### 6️⃣ Start the Application
96+
```bash
97+
ng serve
98+
```
99+
100+
Now, the application should be running!
101+
35102
## Acknowledgments
36103

37104
Special thanks to all the contributors and mentors who supported this project!

0 commit comments

Comments
 (0)