Env example Readme Update

.env.example

@@ -0,0 +1,9 @@
+REACT_APP_API_ENDPOINT = "https://cloud.appwrite.io/v1"
+REACT_APP_WEBSITE_URL="http://localhost:3000"
+REACT_APP_PROJECT_ID= "projectId"
+REACT_APP_DATABASE_ID="databaseId"
+REACT_APP_USERS_COLLECTION_ID="usersCollectionId"
+REACT_APP_EVENTS_COLLECTION_ID="eventsCollectionId"
+REACT_APP_RSVP_COLLECTION_ID="rsvpCollectionId"
+REACT_APP_NOTIFICATIONS_COLLECTION_ID="notificationsCollectionId"
+REACT_APP_IMAGES_BUCKET_ID="imagesBucketId"

README.md

@@ -1,35 +1,153 @@
 # SpotLight
+
 Empowering Individual Creators with Seamless RSVP and Event Management by bringing their creative self to the spotlight
 
 ## Introduction
+
 In the dynamic world of event planning and management, individual creators are constantly seeking ways to streamline their processes and deliver exceptional experiences. Enter Spotlight, the ultimate RSVP and event management web app designed exclusively for creators. In this article, we will explore how Spotlight empowers individual creators by providing intuitive tools to simplify event planning, manage RSVPs effortlessly, and elevate their creative vision.
 
 ## What does Spotlight do?
+
 - ### Streamline Event Planning
-    Spotlight understands the unique needs of individual creators when it comes to event planning. With its user-friendly interface and comprehensive features, it takes the complexity out of organizing events. From setting dates and locations to providing detailed event descriptions and sending tickets, Spotlight ensures that the planning process remains seamless, allowing creators to focus on their artistic endeavors.
+
+  Spotlight understands the unique needs of individual creators when it comes to event planning. With its user-friendly interface and comprehensive features, it takes the complexity out of organizing events. From setting dates and locations to providing detailed event descriptions and sending tickets, Spotlight ensures that the planning process remains seamless, allowing creators to focus on their artistic endeavors.
 
 - ### Effortless RSVP Management
-    Managing RSVPs can be a daunting task, but Spotlight simplifies the process. Creators can effortlessly send invitation links to potential collaborators and volunteers through email. The app provides real-time tracking of RSVPs by sending and receiving notifications, making it easy to manage attendee lists, monitor responses, and ensure accurate headcounts. With Spotlight, creators can confidently stay on top of their event's guest list.
+
+  Managing RSVPs can be a daunting task, but Spotlight simplifies the process. Creators can effortlessly send invitation links to potential collaborators and volunteers through email. The app provides real-time tracking of RSVPs by sending and receiving notifications, making it easy to manage attendee lists, monitor responses, and ensure accurate headcounts. With Spotlight, creators can confidently stay on top of their event's guest list.
 
 - ### Instant Updates for RSVPs and Invitations
-    With real-time notifications in the Spotlight app, event organizers can instantly inform attendees about RSVPs and invitations. As soon as someone RSVPs to an event or the event owner sends an invitation, the app triggers a real-time notification, providing attendees with immediate confirmation. This prompt communication ensures that attendees are promptly notified of their acceptance or invitation status, leaving no room for confusion and enabling them to plan their participation effectively.
+
+  With real-time notifications in the Spotlight app, event organizers can instantly inform attendees about RSVPs and invitations. As soon as someone RSVPs to an event or the event owner sends an invitation, the app triggers a real-time notification, providing attendees with immediate confirmation. This prompt communication ensures that attendees are promptly notified of their acceptance or invitation status, leaving no room for confusion and enabling them to plan their participation effectively.
 
 - ### Accepted and Rejected Invitations
-    Real-time notifications in the Spotlight app play a crucial role in conveying the acceptance or rejection of invitations. Attendees receive timely notifications when their invitation is accepted or declined, allowing them to adjust their plans accordingly. By providing instant updates, the app fosters transparency and ensures that all participants are informed of the event's status, resulting in a smoother event planning process for organizers and attendees alike.
+
+  Real-time notifications in the Spotlight app play a crucial role in conveying the acceptance or rejection of invitations. Attendees receive timely notifications when their invitation is accepted or declined, allowing them to adjust their plans accordingly. By providing instant updates, the app fosters transparency and ensures that all participants are informed of the event's status, resulting in a smoother event planning process for organizers and attendees alike.
 
 - ### Effortless Attendance Tracking
-    With QR Code Scanning, marking attendance becomes a breeze. Attendees can simply present their event tickets or registration QR codes at the entrance, and event organizers can swiftly scan and record their attendance. This eliminates the need for manual check-ins and ensures accurate and efficient tracking of attendees.
+
+  With QR Code Scanning, marking attendance becomes a breeze. Attendees can simply present their event tickets or registration QR codes at the entrance, and event organizers can swiftly scan and record their attendance. This eliminates the need for manual check-ins and ensures accurate and efficient tracking of attendees.
 
 - ### Seamless Integration
-    The QR Code Scanning feature seamlesssly integrates with SpotLight's event management system. Event organizers can easily access the scanning functionality through any QR Code scanning system, making it convenient to manage attendance on-site.
+
+  The QR Code Scanning feature seamlesssly integrates with SpotLight's event management system. Event organizers can easily access the scanning functionality through any QR Code scanning system, making it convenient to manage attendance on-site.
 
 - ### Comprehensive Attendee List Downloads
-    Gaining insights and maintaining a record of attendees is vital for event evaluation and future planning. SpotLight empowers organizers by providing the ability to download a comprehensive list of attendees in an XLSX file format. This list includes essential details such as attendee names, contact information, attendance information, and any additional data captured during registration. The downloadable file can be easily shared with team members, and sponsors, or used for post-event analysis.
+  Gaining insights and maintaining a record of attendees is vital for event evaluation and future planning. SpotLight empowers organizers by providing the ability to download a comprehensive list of attendees in an XLSX file format. This list includes essential details such as attendee names, contact information, attendance information, and any additional data captured during registration. The downloadable file can be easily shared with team members, and sponsors, or used for post-event analysis.
 
 ## Tech Stack Used
+
 - **ReactJs** - for website frontend
 - **Appwrite Cloud Client SDK** - for Database, Storage, User Authentication, Realtime Notifications
 - **TailwindCSS** - for UI styling
 
+## Setup Instructions
+
+To set up the project, follow these steps:
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/pranaygoel02/SpotLight.git
+   ```
+
+2. Navigate to the project directory:
+
+   ```bash
+   cd SpotLight
+   ```
+
+3. Copy the `.env.example` files content to `.env`:
+
+   ```bash
+   cp .env.example .env
+   ```
+
+4. Open the `.env` file and update the necessary variables with your own values.
+
+5. Install the necessary packages:
+
+   ```bash
+   npm install
+   ```
+
+6. Start the project:
+
+   ```bash
+   npm start
+   ```
+
+7. Create a project in Appwrite and collections in the `events` database in appwrite:
+
+   - `events` collection:
+
+     - Attributes:
+       - createdBy
+       - userId
+       - title
+       - description
+       - privacy
+       - medium
+       - startDate
+       - endDate
+       - duration
+       - category
+       - maxParticipants
+       - location
+       - meet
+       - image
+       - imageId
+       - tnc
+       - acceptingAttendance
+       - language
+       - acceptingRsvp
+     - Indexes:
+       - createdBy
+       - userId
+       - privacy
+       - category
+
+   - `notifications` collection:
+
+     - Attributes:
+       - userId
+       - message
+       - fromUserId
+       - fromUserName
+       - link
+       - type
+     - Indexes:
+       - userId
+
+   - `rsvp` collection:
+
+     - Attributes:
+       - userId
+       - eventId
+       - teamId
+       - approved
+       - rejected
+       - eventName
+       - userName
+       - userEmail
+       - ownerUserId
+       - pending
+       - type
+       - membershipId
+     - Indexes:
+       - userId
+       - rsvp
+       - owner
+
+   - `users` collection:
+     - Attributes:
+       - userId
+       - name
+       - email
+       - role
+     - Indexes:
+       - userId
+
 ### [Live Demo](https://spot-light-appwrite.vercel.app)
-### [Read Full Article](https://pranaygoel.hashnode.dev/spotlight)
+
+### [Read Full Article](https://pranaygoel.hashnode.dev/spotlight)