Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sksumit/chatistics
A WhatsApp Chat analyzer and statistics.
https://github.com/sksumit/chatistics
analytics chat data-science flask messaging nextjs pandas python statistics whatsapp whatsapp-chat
Last synced: 2 months ago
JSON representation
A WhatsApp Chat analyzer and statistics.
- Host: GitHub
- URL: https://github.com/sksumit/chatistics
- Owner: SkSumit
- License: gpl-3.0
- Created: 2020-12-29T06:17:46.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-22T16:33:32.000Z (almost 2 years ago)
- Last Synced: 2024-10-01T07:41:16.637Z (3 months ago)
- Topics: analytics, chat, data-science, flask, messaging, nextjs, pandas, python, statistics, whatsapp, whatsapp-chat
- Language: Python
- Homepage: https://chatistics.vercel.app
- Size: 55.7 MB
- Stars: 40
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chatistics
A WhatsApp Chat analyzer and statistics.
Chatistics
A WhatsApp Chat analyzer and statistics.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
-
About The Project
-
Getting Started
- Running
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgements
## About The Project
#### 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
* [Next.js](https://nextjs.org/)
* [Flask](https://flask.palletsprojects.com/en/1.1.x)
* [Pandas](https://pandas.pydata.org/)
## ⚡️ Getting Started
### Prerequisites
Tools needed to run this project
* python
* yarn
### 📦 Installation
1. Clone the repo
```sh
git clone https://github.com/your_username_/Project-Name.git
```
2. Install packages
#### Backend
```bash
cd .\backend\
pip install virtualenv
virtualenv env
env\Scripts\activate
pip install -r requirements.txt
```
#### Frontend
```bash
cd .\frontend\
yarn install
```
3. Get your API Keys for [Firebase](https://firebase.google.com/)
4.Create an `.env` file, in the `backend` folder and add your API keys
```PY
FIREBASE_API_KEY= '',
FIREBASE_AUTH_DOMAIN= '',
FIREBASE_PROJECT_ID= '',
FIREBASE_STORAGE_BUCKET= '',
FIREBASE_MESSAGING_SENDER_ID= '',
FIREBASE_APP_ID= ''
FIREBASE_MEASUREMENT_ID= ''
FIREBASE_DATABASE_URL= ''
```
## 🐎 Running
Backend would be running on PORT 5000
```bash
python run.py
```
***Open new terminal to run front-end***
Frontend would be running on PORT 3000
```bash
yarn run dev
```
## Usage
* For analysing your personal or group chats.
## 🚧 Roadmap
See the [open issues](https://github.com/SkSumit/Chatistics/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](https://www.linkedin.com/in/atharva-kulkarni-b119b7195/) - [email protected]
Sumit Kolpekwar - [@LinkedIn](https://www.linkedin.com/in/sumitkolpekwar/) - [email protected]
Yash Dewangan - [@LinkedIn](https://www.linkedin.com/in/yash-dewangan-903346132/) - [email protected]
Project Link: [Chatistics](https://github.com/SkSumit/Chatistics/tree/main)
## Acknowledgements
* [ReadMe Template](https://github.com/othneildrew/Best-README-Template)
* [Img Shields](https://shields.io)
* [Vercel](https://vercel.com/)
* [Heroku](https://heroku.com/)
* [Bulma](http://bulma.io/)
* [Recharts](http://recharts.org/)
* [Font Awesome](https://fontawesome.com)