https://github.com/dhruv2185/netropolis
Netropolis supports a place where people with shared values can connect digitally to form and operate in a third-place-like community that is neither at home nor at work.
https://github.com/dhruv2185/netropolis
django-rest-framework llm postgresql python qdrant-vector-database reactjs sentence-transformers tailwind-css vite
Last synced: 18 days ago
JSON representation
Netropolis supports a place where people with shared values can connect digitally to form and operate in a third-place-like community that is neither at home nor at work.
- Host: GitHub
- URL: https://github.com/dhruv2185/netropolis
- Owner: dhruv2185
- License: mit
- Created: 2024-02-02T16:24:08.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-11T08:45:09.000Z (almost 2 years ago)
- Last Synced: 2025-06-14T19:35:23.539Z (11 months ago)
- Topics: django-rest-framework, llm, postgresql, python, qdrant-vector-database, reactjs, sentence-transformers, tailwind-css, vite
- Language: JavaScript
- Homepage: https://netropolis-nu.vercel.app
- Size: 94.1 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Netropolis
## Live URL
[Vercel Hosting](https://netropolis-nu.vercel.app/)
Note: This is only a FRONTEND deployment, to use all the features of this app please set up the BACKEND locally by following the steps given below or by watching the demo video (drive link). Also, please ensure that the BACKEND is running on http://localhost:8000/.
## Description
This project tackles the challenges posed by Japan's unique aging population and declining birthrate. Due to the declining population caused by the falling birthrate and aging population, local cities are depopulating, resulting in a loss of workers day by day. In rural areas where labor is scarce, it is increasingly difficult to maintain the history, culture, and economy that local residents have created over the years. This project aims to address the shortage of local workers by bringing in help from outside the region to establish a local city system of economy, culture, and history.
The solution proposed is to provide work tasks that compensate for the labor shortage in rural areas as a package of experiences for staying in the region and matching them with other regions.
The goal of the project is to propose functions to build a matching platform that matches local labor shortage tasks with users who want to experience the local area, providing opportunities for users to enthusiastically and actively tour the area like an RPG game. The platform includes features such as login, quest registration, scheduling, user quest search, and quest request from users.
## Table of Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Built With](#built-with)
## Features
- Login Function: Uses Google OAuth 2.0.
- Quest Registration
- Scheduling Function
- User quest search function: Uses VectorDB and LLM.
- Quest request function from users
- Team Registration
## Getting Started
### Prerequisites
- Python version 3.10.x or newer.
### Installation
- Clone the repository: `git clone https://github.com/dhruv2185/Netropolis.git`
#### Frontend
- Navigate to project directory: `cd netropolis_frontend`
- Install dependencies: `npm install`
#### Backend
- Navigate to project directory: `cd netropolis_backend`
- Create a virtual environment: `python -m venv env`
- Activate the virtual environment:
- For Windows: `/env/Scripts/activate`
- For Linux: `source ./env/bin/activate`
- Install required modules: `pip install -r requirements.txt`
- Initialize application:
- `python manage.py makemigrations`
- `python manage.py migrate`
### Configuration
- Rename `.env.example` in `/netropolis_backend` and `/netropolis_frontend` to `.env`
- Open `.env` and set your configuration varibles.
### Usage
#### Frontend
- Start the app: `npm run dev`
#### Backend
- Start the app: `python manage.py runserver`
### Built With
- React + Vite
- Tailwind CSS
- Django Rest Framework
- PostgreSQL
- Python
- VectorDB
- Sentence transformers(LLM)
## Miscellaneous
- Google Drive link (Demo Video and Documentation for submission) : https://drive.google.com/drive/folders/1vI5s1vZxrFzV2tq2T8qda_DDiJcBPARG?usp=sharing
- Figma Link : https://www.figma.com/file/Ljaj2dko4PNk4VZqJIa4uD/Untitled?type=design&node-id=0%3A1&mode=design&t=O1FUnCXwqboAd29T-1