Skip to content

Latest commit

 

History

History
157 lines (112 loc) · 6.12 KB

README.rst

File metadata and controls

157 lines (112 loc) · 6.12 KB
Raw

TwitStat

Black code style Python 3.8.5 Release Documentation Status MIT License GitHub Stars GitHub Forks
Language:python 3.8.5
License:MIT
Pycharm:Yes

Twitstat is a simple web application that analyses twitter data to provide interesting insights into trending hashtags and topics. It cleverly clusters and charts data to ease the process of better understanding trends around the world!

Basic Project Structure

Branch

  • main branch is used for Production
  • develop branch is used for the development or staging
  • feature_branch branch should create PR to develop branch
  • Delete the feature_branch once merged

Project Board

  • Frontend for the Frontend part of the Application
  • Backend for the backend part of the application
  • Bugs for reporting all the bugs, found on the application

Setup

Code Size Commit Activity Repo Size
  • Setting up your project and environment
# Clone the repository
git clone [email protected]:MLH-Fellowship/twitstat.git
cd twitstat

# Create Virtual Environment
python -m venv venv
source venv/bin/activate

# Install dependencies
python -m pip install -r requirements/local.txt
  • Working in Development Mode
# We use develop branch for development
git checkout -b develop remotes/origin/develop
git checkout -b "your_feature_branch"
  • If your terminal doesn't load .env file automatically
export $(grep -v '^#' .env | xargs)
  • Running locally
flask run

Issues

GitHub issues PRs Welcome GitHub last commit

Track Issues on GitHub

Feel free to open new issue(s) . Make sure you follow the Issue Template provided.

Contribution Guidelines

GitHub pull requests GitHub contributors

Refer CONTRIBUTING.rst for detailed information on Contributing to TwitStat.

  • Write clear meaningful git commit messages (Do read How to Write a Git Commit Message).
  • Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check out Closing Issues via Pull Requests for more info)
  • When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at Squash Commits with Git)
  • When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
  • Please follow the PR Template to create the PR.
  • Always open PR to develop branch.
  • Please read our Code of Conduct.

Contributors

Made with ❤️ by Aditya Raman and Garima Singh!

License

TwitStat is MIT licensed.