TooAngel / TooAngel/worlddriven

Update README.md to reflect modern Node.js stack

Open
#277 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

modernization technical-debt
Dominant language
JavaScript
Stars
18
Forks
15
Avg merge
8d 14h
Merged PRs (30d)
5

Description

The README.md contains outdated information from the legacy Python/Heroku era that needs updating.

Outdated sections identified:

  • References to Python tests (pytest) - should be removed
  • PostgreSQL setup instructions (lines 58-65) - replaced with MongoDB
  • Gunicorn server instructions (line 41) - replaced with Node.js/Express
  • Heroku hosting reference (line 100) - migrated to Dokku
  • Mixed technology references that no longer apply

Context:

  • Complete migration from Python/Flask to Node.js/Express completed
  • Database migrated from PostgreSQL/MariaDB to MongoDB
  • Infrastructure migrated from Heroku to Dokku
  • Build system migrated from Webpack to Vite

Acceptance Criteria:

  • Remove outdated Python/PostgreSQL references
  • Update setup instructions for Node.js/MongoDB stack
  • Correct hosting information (Dokku instead of Heroku)
  • Update testing instructions to reflect current test suite
  • Ensure all technical information matches current architecture
  • Verify all commands and instructions work with current setup

Priority: Medium

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with README.md, especially the Gunicorn instruction at line 41, PostgreSQL setup at lines 58-65, and Heroku reference at line 100. Compare each section with the current Node.js/Express, MongoDB, Dokku, and Vite architecture and testing setup. Done means outdated references are removed, setup and testing instructions are current, and all documented commands and technical details are verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
express, javascript, mongodb, node.js, postgresql, python, vite, webpack
Domain
backend, build-system, databases, devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.