Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
neozhixuan authored May 1, 2023
1 parent ed69b01 commit 12e5549
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,26 @@ The file content is primary in the `client` folder. The `data_science` folder is

### Client Folder
`__tests__`: Page to set up unit tests.

`api`: API calls to Sheety and other platforms are set up here.

`app-context`: React Context is set up in here for ease of transmitting data between pages.

`components`: Components from spa-pages will be abstracted into this folder.

`hooks`: Custom hooks are created in this folder.

`layouts`: Reusable layouts like the BasePage container are created in this folder.

`pages`: Currently stores the index page and connects to `spa-pages`

`public`: Image repository

`spa-pages`: This is where the pages for our Single Page Application are stored.

`theme`: General naming conventions for colors, classes etc.


## better.sg

This is a nonprofit volunteer-run project by better.sg.
Expand Down

0 comments on commit 12e5549

Please sign in to comment.