sblaise123 / coffeechat

makeitMVP Launch Academy: CoffeeChat

Table of Contents

• Introduction
• Features
• Getting Started
  • Prerequisites
  • Installation
  • Technologies Used
• Usage
• Screenshots
• API Documentation
• Contributing
• License

Introduction

Coffee Chat is a platform designed to revolutionize the way professionals network and build meaningful connections. This README provides an overview of the project, its features, and instructions on getting started.

Features

• Smart Matching Algorithm: Connects professionals based on industry, interests, skills, and career goals.
• In-App Chat: Enables real-time messaging for easy communication.
• Meeting Scheduling: Allows users to schedule 1-to-1 coffee meetings with their matches.
• User Profiles: Users can customize their profiles to showcase their professional background.

Getting Started

Prerequisites

• Node.js and npm installed on your local machine.
• MongoDB or another database system set up.
• Authentication system (e.g., OAuth, email and password).

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/coffee-chat.git
   cd coffee-chat
   

2. Install dependencies npm install

3. Set up your environment variables and configuration for authentication and database.

4. Run the app: npm start

Technologies Used

This project makes use of the following technologies, dependencies and tools:

• React: JavaScript library for building the user interface.
• create-react-app: A tool to set up a new React application quickly.
• Firebase: A cloud-based platform for backend services including Firestore and OAuth.
• Node.js: Server-side runtime environment.
• Express: Web application framework for Node.js.
• SCSS/Sass: CSS preprocessor for styling.
• react-icons: A library for adding icons to your React application.
• dotenv: A module for loading environment variables from a .env file.

...Work in Progress

Usage

To use the Coffee Chat app, follow the registration and login process. Create your profile, specify your preferences, and start networking with relevant professionals. You can schedule coffee meetings, chat with your connections, and meet new people.

Screenshots

...Work in Progress

API Documentation

...Work in Progress

Contributing

We welcome contributions from the community. If you have suggestions or improvements for this starter repository, please open an issue or create a pull request. For more information on how to contribute, check our CONTRIBUTING.md file.

License

This project is licensed under the MIT License.