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 2cec11c commit ed69b01
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,22 @@ Start the application:
npm start
```

## Codebase Structure

The file content is primary in the `client` folder. The `data_science` folder is for future data science implementations.

### 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 ed69b01

Please sign in to comment.