hirajanwin / flowie Goto Github PK

The ultimate progress tracker for MLH Fellows. Designed for mentors to gain better insights to their fellows contributions, as well as for the fellows to showcase their progress as an alternative to the daily standup notes, Flowie provides the project management tools that makes it easy to track daily progress.

Motivation

MLH Fellowship has been a great experience under the guidance of the mentors and the maintainers. Working in a pod of 9-11 people, the fellows contribute to open source. However, with so many fellows contributing to a plethora of repositories across the open source space, it becomes hard for mentors and sometimes, even the fellows themselves to track their progress. Currently, Github can be used to view a user's contributions in every repository using the user's profile or all the contributions to a repository using the repository link but it does not provide any view to track how much a particular user has contributed to a single or multiple repositories.

That is why in daily standup notes, it is hard for the mentor to keep up with the progress of fellows to advise them better, particularly, if a fellow is lagging behind and is hesitant to ask for help, the mentor can notice it immediately and provide their support to help the fellow successfully contribute.

Features

A list of documented use cases be found here. A quick overview can be found below:

• Creating daily visual reports for the tracked repos of the user.
• Allow user to add notes to daily reports.
• Group multiple users in a pod and show a combined daily visual reports/stand up notes for it.

Tracking in 4 simple steps!

1) Enter Github Username!

2) Add tracked projects!

3) Select the date or apply the filters!

4) Add daily stand-up notes

Getting started

Django

Run django tests

• Make sure that docker is installed and running. Refer to the official documentation to setup docker for your operating system.
• Run the command below to execute the test suite:

docker-compose -f docker-compose.test.yml up --exit-code-from app

Run django server

• Make sure the appropriate environment variables are setup:
  • DB_NAME (Postgres database name)
  • DB_HOST (Postgres database host)
  • DB_PASSWORD (Postgres database password)
  • DB_PORT (Postgres database port, default 5432)
  • GITHUB_API_KEY (To increase the number of requests available per hour)
• Make sure Python 3.6+ is installed. Refer to the official documentation to setup Python on your operating system.
  • Install dependencies using pip:

  pip install -r backend/requirements.txt
  

  • Run server

  python backend/manage.py runserver
  

React

Install npm modules

npm install package.json

Run development server locally

npm start

You can visit development server at localhost:3000 (default)

Technology Stack

Django: The web framework for perfectionists with deadlines.

Django Rest Framework: Web APIs for Django.

React: A declarative, efficient, and flexible JavaScript library for building user interfaces.

Redux: A predictable state container for JS.

Docker: Docker provides a simple and powerful developer experience, workflows and collaboration for creating applications.

Practices

Test Driven Development and Github Actions were utilized to write the backend for this application. In particular, all the tests are written and made to fail. Then, the actual software logic is written until the tests pass.

Github best practices were followed to collabrate between team mates. In particular, tests are run against each push and pull request using github-actions and deployment process is handled by integrating vercel.

License

This project is licensed under MIT License. Please see LICENSE file for complete details.