https://github.com/ayeshaashfaq12/athlete_connect
The objective of this project is to develop a platform which helps in connecting sport people.
https://github.com/ayeshaashfaq12/athlete_connect
athlete-platform backend-development database-management django event-planning frontend-development fullstack-development match-scheduling open-source python responsive-design rest-api rugby-management sports-app sports-management team-management ui-ux-design user-authentication voting-system web-application
Last synced: about 2 months ago
JSON representation
The objective of this project is to develop a platform which helps in connecting sport people.
- Host: GitHub
- URL: https://github.com/ayeshaashfaq12/athlete_connect
- Owner: AyeshaAshfaq12
- Created: 2024-01-22T02:49:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-08T14:36:20.000Z (over 1 year ago)
- Last Synced: 2025-01-24T21:32:00.331Z (over 1 year ago)
- Topics: athlete-platform, backend-development, database-management, django, event-planning, frontend-development, fullstack-development, match-scheduling, open-source, python, responsive-design, rest-api, rugby-management, sports-app, sports-management, team-management, ui-ux-design, user-authentication, voting-system, web-application
- Language: HTML
- Homepage: https://athleteconnect.co.za
- Size: 17.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ๐ Athlete Connect

**Athlete Connect** is a comprehensive web application designed for organizing and managing Rugby festivals. From hosting events and managing teams to scheduling matches and enabling user voting, Athlete Connect simplifies the administrative and engagement processes for sports festivals.
---
## ๐ Features
- **Event Hosting:** Create and manage Rugby events effortlessly.
- **Team Management:** Add, edit, and organize teams for tournaments.
- **Match Scheduling:** Schedule matches with an intuitive interface.
- **User Voting:** Engage the audience through interactive voting systems.
- **Responsive Design:** Seamlessly accessible on all devices.
---
## ๐ ๏ธ Tech Stack
| Technology | Purpose |
|-------------------|----------------------------|
| **Django** | Backend Framework |
| **Django REST Framework** | API Development |
| **HTML, CSS, JavaScript** | Frontend Development |
| **PostgreSQL** | Database Management |
| **Chart.js** | Data Visualization |
| **Stripe** | Secure Payments |
---
## ๐ Installation
### **Prerequisites**
- Python 3.8+
- Django 4.0+
- PostgreSQL
### **Steps**
1. **Clone the Repository**
```bash
git clone https://github.com/your-username/athlete-connect.git
cd athlete-connect
```
2. **Set Up a Virtual Environment**
```bash
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
3. **Install Dependencies**
```bash
pip install -r requirements.txt
```
4. **Configure Environment Variables**
Create a `.env` file in the root directory and add the following:
```plaintext
SECRET_KEY=your_secret_key
DEBUG=True
DATABASE_URL=postgres://username:password@localhost:5432/athlete_connect
```
5. **Apply Migrations**
```bash
python manage.py migrate
```
6. **Run the Server**
```bash
python manage.py runserver
```
7. **Access the Application**
Open your browser and navigate to [http://localhost:8000](http://localhost:8000).
---
## ๐งช Testing
Run tests to ensure everything is functioning as expected:
```bash
python manage.py test
```
---
## ๐จ UI/UX Design
The platform follows modern design principles to ensure:
- Intuitive navigation
- Mobile-first responsive layouts
- Interactive user interfaces
---
## ๐ Documentation
Comprehensive API documentation is available via Swagger at:
`http://localhost:8000/api/docs`
---
## ๐ Live Demo
Explore the live application at [athleteconnect.co.za](https://athleteconnect.co.za).
---
## ๐ License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.