Merge pull request 'development' (#1) from development into main

Reviewed-on: #1

README.md

@@ -0,0 +1,96 @@
+Table of Contents
+
+Project Overview - Events Management App with full control on admin side.
+
+Key Features
+- Add Events and its related data like venue details.
+- Many types of filter searches for events like preferences and location.
+
+Prerequisites
+
+- Installation
+- Setting Up a Development Environment (Python, Virtual Environment)
+- Cloning the Repository and Installing Dependencies
+- Database Configuration
+- Running the Project
+
+Project Overview
+
+Description:
+- GoodTimes App: Find Fun Events in the UK
+Unforgettable experiences await! The GoodTimes app helps you discover and plan exciting events happening across the UK.
+
+Key Features:
+
+- Discover a Variety of Events: Explore a wide range of events tailored to your interests, from concerts and festivals to workshops and sporting events.
+Effortless Event Creation: Planning an event yourself? GoodTimes makes it easy to add your event along with its details, including venue information.
+Powerful Search Filters: Narrow down your event search using filters based on your preferences and location. Find events happening near you or explore options in specific cities across the UK.
+Seamless Event Planning: Get all the information you need in one place. View event details, venue information, and make informed decisions about the events you want to attend.
+With GoodTimes, you'll never miss out on the fun!
+
+
+Basic Computer Knowledge: No prior Python experience is required, but basic computer literacy will be helpful.
+Text Editor or IDE: Any text editor or Integrated Development Environment (IDE) that supports Python will work. Some popular options include:
+Visual Studio Code
+PyCharm (Community Edition is free)
+Sublime Text
+Atom
+
+Installation
+
+Setting Up a Development Environment:
+
+Install Python (3.10): https://www.python.org/downloads/
+Install a virtual environment tool like virtualenv: https://docs.python.org/3/library/venv.html
+
+Create a virtual environment:
+
+python virtualenv my_env  # Using venv
+source my_env/bin/activate  # Activate on Linux/macOS
+
+Cloning the Repository and Installing Dependencies:
+
+Clone this repository using Gitea: http://git.wdipl.com/Rizwan.Shaikh/goodtimes
+
+git clone http://git.wdipl.com/Rizwan.Shaikh/goodtimes
+
+Navigate to the project directory:
+
+cd <goodtimes>
+
+Activate your virtual environment (if not already active).
+
+Install project dependencies:
+
+pip install -r requirements.txt
+
+Database Configuration:
+
+Create a database for your project using MySQL. Refer to your database's documentation for setup instructions.
+
+Running the Project
+
+Development Server:
+
+Activate your virtual environment (if not already active).
+
+Add fixtures for user types:
+python manage.py load_custom_fixture
+
+Add 10 Event Categories from admin dashboard with images(all images for categories inside static/images):
+1. Arts & Entertainment - image - Black.png
+2. Business & Economic - image - business.png
+3. Health & Wellness - image - health.png
+4. Leisure & Hobbies - image - leisure.png
+5. Cultural & Social - image - cultural.png
+6. Education & Technology - image - education.png
+7. Outdoor Activities - image - outdoor.png
+8. Recreation & Sports - image - recreation.png
+9. Family - image - cultural.png
+10. Shopping Sale - image - business.png
+
+Start the development server:
+
+python manage.py runserver
+
+This will start a local server at http://127.0.0.1:8000/ (or a different port depending on your settings) where you can access your Django application.