README.md

Teamify

Hosting your own Team Chat was never easier
Note: This Repository got archived and is no longer supported
Explore the docs »

View Demo · Report Bug · Request Feature
 

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. To do
6. Contributing
7. License
8. Contact
9. Contributors

About The Project

Host your own Slack

Built With

• React.js
• Redux
• Firebase
• Material UI

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm
• NodeJS
• yarn

  npm install --global yarn

• NextJS

  yarn add react-redux

Installation

1. Clone the repo

   git clone https://github.com/jusoftdev/teamify.git

2. Install yarn packages

   yarn

3. Create Firebase Project
4. Add Firebase to your Web-App (Create App/Platform) and copy the config
5. Paste the config in src/firebase.js

   const firebaseConfig = {
   Enter your Config here
   };

6. Enable Cloud Firestore
7. Enable Authentication & Select Google (easiest & simplest way)
8. Run the app

   yarn start

9. Build the app (optional)

   yarn build

Usage

Beautiful responsive design
Chatting with other Users
Creating own Channels

Simple & Easy Google Login

Roadmap

See the open issues for a list of proposed features (and known issues).

Todo

• Threads
• Apps
• File Browser / Media Upload
• User Groups
• Mentions & Reactions

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

JuSoft - @jusoftdev - Discord Server - support@jusoft.dev

Project Link: https://github.com/jusoftdev/teamify

Contributors

• juhom205