Skip to content

HackHarvard | A social app that connects people near you of common interest. Developed with MERN stack, MapboxGL, Websocket.

Notifications You must be signed in to change notification settings

khanhdo05/proximity

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Proximity

Overview

Proximity is a networking application that enables users to log in and discover people around them within a 1-mile radius. The uniqueness of the app lies in its anonymity aspect—users won’t see others' names or personal details but instead receive information in the form of labels like "1 person from MIT," "2 people interested in cinema," or "3 people from Amazon." Users can customize the labels they wish to display on their profile and choose labels that interest them from others. Interaction begins when a user sends a connection request to another based on these labels, and the recipient has the option to accept or decline. Once accepted, they can chat and arrange to meet in real life for networking purposes.

home

Tech Stack

  • Frontend: React JavaScript
  • Backend: Node.js, Express, JavaScript
  • Database: MongoDB
  • Map API: Mapbox GL
  • Real-time Communication: Websocket

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm (v6 or higher)
  • MongoDB

Installation

  1. Clone the repository:

    git clone https://github.com/khanhdo05/proximity.git
    cd proximity
  2. Install dependencies for both frontend and backend:

    npm run install:all
  3. Set up environment variables: Create a .env file in the backend directory and add the following:

    MONGO_URI=your_mongodb_connection_string

    Create a .env file in the frontend directory and add the following:

    REACT_APP_MAPBOX_ACCESS_TOKEN=your_mapbox_access_token

    Any other environment variables can be added to the .env file as needed. If in frontend, must prefix the variable with REACT_APP_ to make it available in the React app.

Running the Application

  1. Start both backend and frontend servers:

    npm start
  2. Access the application: Open your browser and navigate to http://localhost:3000

Formatting code with Prettier

npm run format

About

HackHarvard | A social app that connects people near you of common interest. Developed with MERN stack, MapboxGL, Websocket.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published