https://github.com/s13g/adconnect
Facilitate seamless advertisement posting for events, perform CRUD operations, create matrimonial profiles, and connect with people using ADConnectAPI.
https://github.com/s13g/adconnect
ads connection daphne django django-rest-framework docker docker-compose mariadb neondb postgresql python railway redis
Last synced: 6 months ago
JSON representation
Facilitate seamless advertisement posting for events, perform CRUD operations, create matrimonial profiles, and connect with people using ADConnectAPI.
- Host: GitHub
- URL: https://github.com/s13g/adconnect
- Owner: S13G
- Created: 2023-06-09T23:53:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-10T16:49:31.000Z (almost 2 years ago)
- Last Synced: 2025-04-15T23:15:14.300Z (6 months ago)
- Topics: ads, connection, daphne, django, django-rest-framework, docker, docker-compose, mariadb, neondb, postgresql, python, railway, redis
- Language: JavaScript
- Homepage: https://adconnect.up.railway.app/
- Size: 4.98 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ADConnectAPI - Advertisement and Matrimonial Connection API
AdConnect icon created by Freepik - Flaticon
Facilitate seamless advertisement posting for events, perform CRUD operations, create matrimonial profiles, and connect
with people using our API - ADConnectAPI.
## AdConnect API Link
https://adconnect.up.railway.app/
## Table of Contents
- [Introduction](#adconnectapi---advertisement-and-matrimonial-connection-api)
- [Key Features](#key-features)
- [Testing](#testing)
- [Additional Tips](#additional-tips)
- [Getting Started](#getting-started)
## Key Features
1. **Advertisement Management:** Simplify the process of posting and managing ads for events. Admin approval ensures
quality ads.
2. **Matrimonial Profiles:** Create detailed matrimonial profiles and connect with potential partners.
3. **Real-Time Chat:** Engage in real-time chat for both advertisement and matrimonial connections.
4. **Connection Requests:** Allow users to send and receive connection requests for events or matrimonial profiles.
5. **Favorite Listings:** Save and organize favorite ads and matrimonial profiles for quick access.
6. **Filtering Options:** Efficiently filter ads and profiles based on user preferences.
## Testing
- Seamless advertisement posting and management
- Successful creation and connection of matrimonial profiles
- Reliable real-time chat functionality
- Admin approval for quality ads
- Connection request handling
- Favorite ads and profiles feature
- Advanced filtering options
## Technologies used for API
- Python
- Django, Django Rest Framework
- SQLite3, PostgreSQL
- Docker and Docker-Compose
- Railway for deployment
- Neon.tech for database
- Cloudinary
- Gmail for free email
## Getting Started
Follow these steps to get the project up and running on your local machine:
1. Clone the repository:
```
git clone https://github.com/S13G/AdConnect.git
```
2. Navigate to the project directory:
```
cd AdConnect
```
3. Rename the ``.env.template`` to ``.env`` and update the values.
4. Build and run the service with
```
docker-compose up --build
```
or execute the command below in case permission is denied and root user/permission is needed
```
sudo docker-compose up --build
```
The service will build and run on port ``8000``
5. Launch a new terminal session and run the following commands(if you are not using docker, but for
caution: `run them`)
```
django mm
```
The command above runs the migrations if there are some unapplied migrations
```
django m
```
The command above performs the database migrations
6. Create an admin user with the command below(make sure you fill in the admin details in the env):
```
django createsu
```
After creating the superuser, access the admin panel and login with your admin credentials with the
link https://localhost:8000/admin/
### Admin Login Screen
### Admin Dashboard Screens (Has both Light and Dark Modes)
7. Add your data through the swagger doc and you can download the schema and import it into your postman collection