Friend Finder

Connect with new friends based on mutual interests!

Introduction • Project Overview • Technologies • Installation • Running the Project • Features • Future Additions • Database Configuration • Contributing •

---

Introduction

Welcome to the Friend Finder project! This repository contains the source code for a friend-finding application where users can like each other and get matched. The application's core functionality is to facilitate finding new friends based on mutual interests and preferences.

Project Overview

The Friend Finder project aims to create a user-friendly and efficient platform for making new connections and building meaningful friendships. Users can view other profiles, like or dislike them, and get matched with users who have reciprocated interest.

Technologies

The Friend Finder project utilizes the following technologies:

• React - A JavaScript library for building user interfaces
• Typescript - A superset of JavaScript that adds static types
• Tailwind CSS - A utility-first CSS framework
• Jest - A JavaScript testing framework
• Passport - An authentication middleware for Node.js
• Passport JWT - A Passport strategy for authenticating with JSON Web Tokens
• Node.js - A runtime environment for executing JavaScript code on the server
• Express - A minimal and flexible Node.js web application framework
• PostgreSQL - A powerful, open-source relational database system
• Prisma - A modern database toolkit for Node.js and TypeScript

These technologies have been combined to create a feature-rich and dynamic application that enables users to connect and find friends based on their interests and preferences. Passport JWT is used for implementing secure authentication using JSON Web Tokens, adding an additional layer of security to the application.

Installation

To install the project and its dependencies, follow these steps:

1. Clone the repository to your local machine:

2. Change into the project's directory:

3. Install the dependencies for both the client and server:

Running the Project

To run the project locally, follow these steps:

1. Start the client and server concurrently:

2. Open your web browser and navigate to http://localhost:5173 to access the Friend Finder application.

Features

The current version of the Friend Finder application includes the following features:

• User registration and authentication
• Liking and matching with other users
• Real-time chat
• User Profile Customization Options

Future Additions

In the future, I plan to add the following exciting features:

• Enhanced User Interface and Design
• Advanced Filters for searching and matching users based on preferences
• Basic user search functionality

Database Configuration

The Friend Finder application uses a database to store user information and match data. To configure your own database settings, please follow these steps:

1. Install Prisma in the server's folder:

2. Navigate to the server directory and configure your database in the .env file. Replace the placeholders with your actual database connection URL and credentials:

3. Set up the database and generate the Prisma client:

4. Optionally, you can use Prisma Studio to explore your database:

Contributing

Contributions to the Friend Finder project are welcome! If you have any ideas, bug fixes, or feature requests, please create a pull request. For major changes, please open an issue first to discuss your proposal.