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.
- Frontend: React JavaScript
- Backend: Node.js, Express, JavaScript
- Database: MongoDB
- Map API: Mapbox GL
- Real-time Communication: Websocket
- Node.js (v14 or higher)
- npm (v6 or higher)
- MongoDB
-
Clone the repository:
git clone https://github.com/khanhdo05/proximity.git cd proximity
-
Install dependencies for both frontend and backend:
npm run install:all
-
Set up environment variables: Create a
.env
file in thebackend
directory and add the following:MONGO_URI=your_mongodb_connection_string
Create a
.env
file in thefrontend
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 withREACT_APP_
to make it available in the React app.
-
Start both backend and frontend servers:
npm start
-
Access the application: Open your browser and navigate to
http://localhost:3000
Formatting code with Prettier
npm run format