Lots of room to improve. Start with a README and CI.
Using Python, Docker, Flask, Jinja, Bootstrap, HTML, CSS and MySQL I built an application that is designed to journalize all stocks in a given portfolio. I also implemented Oauth2 to make it easier for users to login using their Google Accounts. In the near future, I will look to integrate Yahoo Finance modules to make the application retrieve the latest stock prices. Additionally, I plan to scrape Top Financials News Sites such as GuruFocus, Seeking Alpha, and Yahoo News and capture the latest news for the given company.
Documentation
53
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).
→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.
README is present.
README documents how to install the project.
Engineering
10
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
No CI configuration detected in this repository.
→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
No linter or formatter config found.
→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.
No issue or PR templates found (−100 pts).
→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
Lockfile present (app/requirements.txt). Installs are reproducible.
Project health
69
No pushes in over 2 years. Looks unmaintained (−95 pts).
→ A recent commit signals the project is alive and worth using.
.gitignore present.
Dependency manifest found (app/requirements.txt).
Repository has a description.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 3Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 1Watchers
Responsiveness
- —Median issue response
- —Median PR merge time
- 0Open issues
Repository files8 root entries
- .ideaIssue: Build artifacts or local files may be committed (.idea/.gitignore) (−40 pts).Fix: Remove them and add to .gitignore.
- appGood: Lockfile present (app/requirements.txt). Installs are reproducible.Good: Environment pinned via app/Dockerfile.Good: Dependency manifest found (app/requirements.txt).
- db
- screenshots
- .gitignoreGood: .gitignore present.
- docker-compose.yml
- Final Web Application Features.pdf
- README.mdGood: README is present.Good: README is well structured with multiple sections.Good: README includes screenshots or visuals. Great for first impressions.Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.Good: README links to a live demo or deployed app.Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.Good: README documents how to install the project.Good: README documents how to run the project.