nickkeers/first-thousand-words
Watch
1
0
Fork
You've already forked first-thousand-words
 0
Code Issues 51 Pull requests Projects 1 Releases Packages Wiki Activity Actions

Document the dev environment in the README #4

New issue
Open
opened 2026-09-26 13:58:28 +00:00 by belvedere · 0 comments
belvedere commented 2026-09-26 13:58:28 +00:00
Collaborator
Copy link

Objective: A new contributor can go from clone to running server from the README alone.

Files:

  • Modify: README.md

Steps:

  1. Replace the generated Phoenix text with: prerequisites, toolchain install, Postgres,
    mix setup, mix phx.server, mix test, mix precommit.
  2. Document the dev URLs: app, /dev/dashboard, /dev/errors (error_tracker), /dev/mailbox.

Verify: Follow the README on a clean checkout and reach the home page.

**Objective:** A new contributor can go from clone to running server from the README alone. **Files:** - Modify: `README.md` **Steps:** 1. Replace the generated Phoenix text with: prerequisites, toolchain install, Postgres, `mix setup`, `mix phx.server`, `mix test`, `mix precommit`. 2. Document the dev URLs: app, `/dev/dashboard`, `/dev/errors` (error_tracker), `/dev/mailbox`. **Verify:** Follow the README on a clean checkout and reach the home page.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels   
area
auth
 Authentication and authorisation

  
area
data
 Word frequency + translation import pipeline

  
area
domain
 Ash resources, domains, policies, migrations

  
area
infra
 Releases, deployment, CI

  
area
stats
 Progress tracking, dashboards, analytics

  
area
study
 Spaced-repetition engine, decks, cards, reviews

  
area
tooling
 Local dev environment, mix tasks, editor tooling

  
area
ui
 LiveView practice experience and app shell

  
duplicate
Created by an over-eager re-run; safe to delete

  
future
Explicitly deferred beyond v1; tracked so it is not forgotten

  
kind
bug
 Something is broken

  
kind
chore
 Setup, tooling, mechanical work

  
kind
decision
 An architectural decision that needs recording

  
kind
docs
 Documentation

  
kind
feature
 New user-facing or domain capability

  
kind
spike
 Time-boxed investigation; output is a written finding, not code

  
kind
test
 Test coverage work

  
prio
blocker
 Blocks other work; do first

  
risk
high
 Correctness-sensitive or hard to reverse

No labels
area
auth
area
data
area
domain
area
infra
area
stats
area
study
area
tooling
area
ui
duplicate
future
kind
bug
kind
chore
kind
decision
kind
docs
kind
feature
kind
spike
kind
test
prio
blocker
risk
high
Milestone
Clear milestone
No items
Projects
Clear projects
No items
No project
First thousand words
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
nickkeers/first-thousand-words#4
No description provided.