Skip to content

Latest commit

 

History

History
203 lines (140 loc) · 4.91 KB

README.md

File metadata and controls

203 lines (140 loc) · 4.91 KB
Raw

Chatistics

A WhatsApp Chat analyzer and statistics.

GitHub contributors GitHub forks GitHub Repo stars Packagist License


Logo

Chatistics

A WhatsApp Chat analyzer and statistics.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Running
  4. Usage
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgements

About The Project

product-gif

Chatistics is an open source WhatsApp chat analyzer, which provides fun and meaningful insights. We respect privacy and do not store the chats, we only store filenames for our analytics.

Built With

Frameworks used in the website

⚡️ Getting Started

Prerequisites

Tools needed to run this project

  • python
  • yarn

📦 Installation

  1. Clone the repo 
    git clone https://github.com/your_username_/Project-Name.git
  2. Install packages

Backend

cd .\backend\
pip install virtualenv
virtualenv env
env\Scripts\activate
pip install -r requirements.txt

Frontend

cd .\frontend\
yarn install
  1. Get your API Keys for Firebase

4.Create an .env file, in the backend folder and add your API keys

FIREBASE_API_KEY= '<Your API KEY>',
FIREBASE_AUTH_DOMAIN= '<Your API KEY>',
FIREBASE_PROJECT_ID= '<Your API KEY>',
FIREBASE_STORAGE_BUCKET= '<Your API KEY>',
FIREBASE_MESSAGING_SENDER_ID= '<Your API KEY>',
FIREBASE_APP_ID= '<Your API KEY>'
FIREBASE_MEASUREMENT_ID= '<Your API KEY>'
FIREBASE_DATABASE_URL= '<Your API KEY>'

🐎 Running

Backend would be running on PORT 5000

python run.py

Open new terminal to run front-end

Frontend would be running on PORT 3000

yarn run dev

Usage

  • For analysing your personal or group chats.

🚧 Roadmap

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

🔧 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 GNU General Public License. See LICENSE for more information.

🤙 Contact

Atharva Kulkarni - @LinkedIn - [email protected]

Sumit Kolpekwar - @LinkedIn - [email protected]

Yash Dewangan - @LinkedIn - [email protected]

Project Link: Chatistics

Acknowledgements