Welcome to the backend repository of Lynk Up! Lynk Up is a social event management app designed to streamline the organization, attendance, and management of events across different friend groups. This repository houses the codebase for our backend services, intricately crafted using Python and the Django REST framework.
- Introduction
- Table of Contents
- Directory
- About
- Tech Stack
- Key Features
- Getting Started
- RESTful Endpoints
- Team
- Contact
- Contribute
- Licensing
Our backend services are at the heart of the Lynk Up app. They manage data, ensure smooth API integrations, provide secure user authentication, enable efficient event management, and prompt notification services. With Python and Django REST framework, we ensure a fast, reliable, and secure environment for our users.
- Python: Our primary programming language offering simplicity and versatility.
- Django REST Framework: Used for building APIs, ensuring a scalable and secure connection between our frontend and backend services.
- Data Management: Employs Django ORM for seamless database queries and data manipulation.
- API Integrations: Manages and integrates external APIs to augment app functionality.
- Event Management: Handles all CRUD operations related to events, enabling the creation, updates, deletions, and RSVP functionalities.
- Clone the Repository: Get started with Lynk Up Backend by cloning the repository to your local machine.
- Install Dependencies: Navigate into the cloned repository and install necessary dependencies.
- Start the Server: Fire up the Django server. Note: Please ensure you have Python and pip installed on your machine before running these commands.
Base url to reach the endpoints listed below:
https://lynk-up-server.onrender.com
All Endpoints
GET /users/:user_id/Details
Request:
No Parameters
| Code | Description |
|---|---|
| 200 | OK |
Response:
{
"data": {
"id": "1",
"attributes": {
"user_name": "Tesseract",
"phone_number": "888-888-8888",
"full_name": "Antonio King Hunt",
},
"events": [
{
"id": 1,
"group": 1,
"group_name": "Best Buds",
"title": "Magic Tournament",
"date": "05-23-2023",
"time": "7:00pm",
"address": "123 fun st.",
"description": "Fun times with fun people"
},
{etc}
]
}
}| Code | Description |
|---|---|
| 404 | NOT FOUND |
Response:
{
"error": [
"title": "NOT FOUND",
"status": "404"
]
}GET /events/:event_id/Details
Request:
{
"event_id": 1
}| Code | Description |
|---|---|
| 200 | OK |
Response:
{
"data": {
"id": 1,
"group": 1,
"group_name": "Best Buds",
"title": "Magic Tournament",
"date": "05-23-2023",
"time": "7:00pm",
"address": "123 fun st",
"description": "Fun times with fun people"
}
}| Code | Description |
|---|---|
| 404 | NOT FOUND |
Response:
{
"error": [
"title": "NOT FOUND",
"status": "404"
]
}POST /events/Details
Request:
{
"title": "Party at the Park",
"date": "05-23-2023",
"time": "6:00pm",
"address": "6 Paper st",
"description": "PARTY!",
"group": 1
}| Code | Description |
|---|---|
| 201 | Created |
Response:
{
"id": 2,
"group": 1,
"group_name": "Best Buds",
"title": "Party at the Park",
"date": "05-23-2023",
"time": "6:00pm",
"address": "6 Paper st",
"description": "PARTY!"
}POST /events/:event_id/Details
Request:
{
"event_id": 1,
}| Code | Description |
|---|---|
| 204 | NO CONTENT |
Response:
No Response
Errors:
| Code | Description |
|---|---|
| 404 | NOT FOUND |
GET /events/Details
Request:
No Parameters
| Code | Description |
|---|---|
| 200 | OK |
Response:
{
"data": [
{
"id": 1,
"group": 1,
"group_name": "Best Buds",
"title": "Magic Tournament",
"date": "05-23-2023",
"time": "7:00pm",
"address": "123 fun st",
"description": "Fun times with fun people"
},
{
"id": 2,
"group": 1,
"group_name": "Best Buds",
"title": "Party at the Park",
"date": "05-23-2023",
"time": "6:00pm",
"address": "6 Paper 2t",
"description": "PARTY!"
},
{
"id": 3,
"group": 2,
"group_name": "Gal Pals",
"title": "Galentine's Day",
"date": "02-13-2024",
"time": "12:00pm",
"address": "49th st",
"description": "Hanging with Leslie, April, Ann, and Donna"
},
(etc.)
]
}| Code | Description |
|---|---|
| 404 | NOT FOUND |
Response:
{
"error": [
"title": "NOT FOUND",
"status": "404"
]
}GET /users/:user_id/friends/Details
Request:
No Parameters
| Code | Description |
|---|---|
| 200 | OK |
Response:
{
"data": {
"friends": [
{
"user_id": 1,
"user_name": "Joe Fogiato"
},
{
"user_id": 2,
"user_name": "Dawson T"
}
]
}
}| Code | Description |
|---|---|
| 404 | NOT FOUND |
Response:
{
"error": [
"title": "NOT FOUND",
"status": "404"
]
}POST /users/:user_id/friends/Details
Request:
{
"friend_id": 1,
"user_id": 1
}| Code | Description |
|---|---|
| 201 | Created |
Response:
{
"data": {
"friends": [
{
"user_name": "Harrison Ryan",
"user_id": 1
},
{
"user_name": "Joe Fogiato",
"user_id": 3
},
{
"user_name": "Antonio KH",
"user_id": 4
},
{
"user_name": "Trevor Fitz",
"user_id": 5
}
]
}
}POST /users/:user_id/friends/Details
Request:
{
"friend_id": 1,
}| Code | Description |
|---|---|
| 204 | NO CONTENT |
Response:
No Response
Errors:
| Code | Description |
|---|---|
| 404 | NOT FOUND |
GET /groups/Details
Request:
No Parameters
| Code | Description |
|---|---|
| 200 | OK |
Response:
{
"data": [
{
"id": 1,
"name": "Best Buds",
"updated": "2023-05-23T23:35:10.294701Z",
"created": "2023-05-23T23:35:10.294724Z",
"user": 1,
"friends": [
1,
2,
(etc,)
]
},
{
"id": 2,
"name": "Gal Pals",
"updated": "2023-05-24T16:46:29.542505Z",
"created": "2023-05-24T16:46:29.542545Z",
"user": 1,
"friends": [
1,
2,
3,
(etc,)
]
},
(etc,)
]
}| Code | Description |
|---|---|
| 404 | NOT FOUND |
Response:
{
"error": [
"title": "NOT FOUND",
"status": "404"
]
}GET /groups/:group_id/Details
Request:
No Parameters
| Code | Description |
|---|---|
| 200 | OK |
Response:
{
"data": {
"id": 1,
"name": "Best Buds",
"updated": "2023-05-23T23:35:10.294701Z",
"created": "2023-05-23T23:35:10.294724Z",
"user": 1,
"friends": [
1,
2,
(etc,)
]
}
}| Code | Description |
|---|---|
| 404 | NOT FOUND |
Response:
{
"error": [
"title": "NOT FOUND",
"status": "404"
]
}POST /groups/:group_id/delete/Details
Request:
{
"group_id": 1,
}| Code | Description |
|---|---|
| 204 | NO CONTENT |
Response:
No Response
Errors:
| Code | Description |
|---|---|
| 404 | NOT FOUND |
| Andra Helton | Antonio King Hunt | Dawson Timmons | Harrison Ryan | William Lampke |
|---|---|---|---|---|
 |
 |
 |
 |
 |
 Github
 LinkedIn
|
Github
LinkedIn
|
Github
LinkedIn
|
Github
LinkedIn
|
Github
LinkedIn
|
For any questions or suggestions, please open an issue in this repository.
We're excited to welcome contributions from everyone, irrespective of their experience level. Your input is crucial in helping us make Lynk Up better. Let's collaborate and build a top-notch social event management app together!
This project is intended to be open source. While a specific license has not been chosen yet, it is our intention to make the code and resources freely available for others to use, modify, and distribute. Until a license is selected, all rights to the code, documentation, and other project resources are reserved. Unauthorized use, distribution, or modification of any part of this project is prohibited.
Thank you for being part of our community! Together, let's make Lynk Up the best social event management app on the market.