Skip to content

Latest commit

 

History

History
89 lines (69 loc) · 3.81 KB

README.md

File metadata and controls

89 lines (69 loc) · 3.81 KB
Raw
Mate

Mate

Mate is a new age, instant messaging service that also provides optional
end-to-end encrypted chats, file sharing, and several other features.

MIT License Start
Twitter

👉 If you like this repo then please give it a ⭐️


Screenshots

Description

Mate is an open-source project that is designed to make it easier to find and connect with like-minded individuals in a given community. The project is built with a focus on community building and user engagement.

The project includes a web application that allows users to interact with each other in real-time through chat and messaging features. Additionally, the project includes a recommendation system that suggests other users to connect with each other based on a user's interests and activities.

The Mate project is built with modern web technologies such as TypeScript, React, and Node.js and is designed to be highly performant and scalable. The project also includes a robust set of tech stack and follows Airbnb's best practices.

Overall, the Mate project aims to bring people together and foster a sense of community and belonging. It is perfect for anyone looking to expand their social circle, find like-minded individuals and explore new interests.

Features

  • Chat and indulgue in a conversation
  • Invite and add friends
  • Login/Register
  • Share images

Tech Stack

  • React JS
  • Vite (Frontend tooling)
  • SCSS
  • SMTP
  • Typescript
  • ESLint
  • Firebase
  • Easy Peasy (For state management)

Quickstart

Follow these steps to get up and running with the project on local

  • Open your terminal (NOTE: git bash prefered/ Terminal on VS Code)
  • Navigate to the project folder where you have cloned this repo.
  • Install the packages using yarn yarn install
  • Export the necessary envs
  • Run the local frontend server: yarn dev

Core Team


Sayan		 👋 Hi, I'm Sayan and I am the creator of Mate, don't hesitate to contact me on Twitter or email if you are curious about the project in any way.

Pull Request

Pull Requests are welcome. Please follow these rules for the ease of understanding:

  • Make sure to check for available issues before raising one
  • Give me a maximum of 24-48 hours to respond
  • Have proper documentation on the parts you are changing/adding

Feel free to contribute