{"id":23135458,"url":"https://github.com/mlh-fellowship/standupsummary","last_synced_at":"2025-04-04T08:23:50.396Z","repository":{"id":103305349,"uuid":"279357767","full_name":"MLH-Fellowship/standupSummary","owner":"MLH-Fellowship","description":"A web app that takes in your stand-up notes on MLH Github, returns a list of most frequently used words, and generates new sentences from the words.","archived":false,"fork":false,"pushed_at":"2020-07-26T21:09:47.000Z","size":9740,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-09T19:33:25.366Z","etag":null,"topics":["mlh","react"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MLH-Fellowship.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-13T16:37:24.000Z","updated_at":"2020-08-13T06:38:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"e035112d-c1f7-4bd5-a617-dd88a8291d4a","html_url":"https://github.com/MLH-Fellowship/standupSummary","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MLH-Fellowship%2FstandupSummary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MLH-Fellowship%2FstandupSummary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MLH-Fellowship%2FstandupSummary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MLH-Fellowship%2FstandupSummary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MLH-Fellowship","download_url":"https://codeload.github.com/MLH-Fellowship/standupSummary/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247143529,"owners_count":20890963,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mlh","react"],"created_at":"2024-12-17T12:15:30.794Z","updated_at":"2025-04-04T08:23:50.387Z","avatar_url":"https://github.com/MLH-Fellowship.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Standup Summary\n\n## General information\n`Standup Summary` is a web app that takes in your stand-up notes on MLH Github, returns a list of most frequently used words, and generates a new sentence based on user's past comments using Markov chain rule.\n\nInspired by the MLH Fellowship [Halfway Hackathon](https://mlh-fellowship.gitbook.io/fellow-handbook/events/halfway-hackathon) to improve the experiences of current and future fellows, this `Standup Summary` project aims to provide a tool for fellows to recap their summer work and generate resume-ready work descriptions!\n\n## Installation\n### Dependencies\nThe project uses [React](https://reactjs.org/) front-end and [Flask](https://flask.palletsprojects.com/en/1.1.x/) back-end. To install the project, your machine must have `python` and `npm` installed.\n\nNow, to install the front-end, nagivate to `/client` folder and run `npm install`; and to install the back-end, navigate to `standupSummary/server/` and run `pip install -r requirements.txt`.\n\n### Database\nOnce you have installed all the dependencies, let's create the sqlite3 database `login.db` locally on your machine. \nTo start, navigate to the `/server` folder and run:\n\n```\nsqlite3 login.db\n.tables\n.exit\n```\n\nOnce `login.db` is created, let's start a python interactive session to create the db tables in `login.db`. \nTo start a python interactive session run:\n\n```\npython\nfrom app import db\ndb.create_all()\nquit()\n```\n\n### Server\nOnce you have installed all the dependencies and created `login.db`, let's fire up our servers. To start the React server, run:\n```\ncd client/\nnpm start\n```\n\nTo start the Flask server, on a new terminal, run:\n```\nexport OAUTHLIB_INSECURE_TRANSPORT=1\nexport OAUTHLIB_RELAX_TOKEN_SCOPE=1\nexport FLASK_APP=app.py\ncd standupSummary/server/\nflask run\n```\nThe first two commands allow us to utilize GitHub Oauth without an https request, while the subsequent commands start the Flask server.\n\n\nOnce you have started **both** React and Flask servers, you can use your browser to navigate to `http://localhost:3000/` and start using our app!\n\n*Note: by default, the Flask server will run on localhost:5000 and React server will run on localhost:3000. If these ports are already in use, you will have to free these ports first before starting the servers in order for the web app to work properly.*\n\n\n## User guide\nOnce you start the servers, you are greeted with the login screen. After you have logged in, you can choose to see your most frequently used words by choosing the *right* pod (note that only members of a port can see comments of that port). Then, you are directed to the following screen with the most frequent words that you used in your stand-up notes (excluding all English stop words).\n\n![](https://i.imgur.com/a8udbbz.gif)\n\nIn addition, you can generate a new sentence based on your comments using the `Generate a new sentence` button. \n\n## Development guide\n### Access token\nIf you are interested in further developing the web app, you first should get [Github Personal Access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). \n\nFor authentication access token, .... #TODO\n\n### Future directions\n1. Serve the static React files with Flask to make deployment easier\n2. Deploy the app to a live website\n3. Improve the sentence generator to make it resume-ready\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlh-fellowship%2Fstandupsummary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmlh-fellowship%2Fstandupsummary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlh-fellowship%2Fstandupsummary/lists"}