Skip to content

Commit

Permalink
Adding a readme explanation of layout
Browse files Browse the repository at this point in the history
so that I can quickly remember what I was doing here when
I haven't looked in months
  • Loading branch information
rossdrew committed Apr 11, 2024
1 parent 7081d7b commit 9fc8195
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions journal-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

It follows what I believe is a pretty standard React app layout.
- [App](src/app.js) is the entry point
- [BufferedJournalEntries](src/components/bufferedJournalEntries.js) (a buffering version of [JournalEntries](src/components/journalEntries.js)
- [HeaderControl](src/components/headerControl.js) containing the entry filtering components and some versioning text
- A listing of 0 or more [JournalEntry](src/components/headerControl.js)
- [FootControl](src/components/footControl.js) containing the entry creation components

---

## Available Scripts

In the project directory, you can run:
Expand Down

0 comments on commit 9fc8195

Please sign in to comment.