Skip to content

Commit 83ec52f

Browse files
committed
More documentation
1 parent 5e3fe8a commit 83ec52f

File tree

3 files changed

+27
-6
lines changed

3 files changed

+27
-6
lines changed

.gitignore

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,4 +196,12 @@ yarn-error.log*
196196

197197
/.fab
198198
/fab.zip
199-
!/.env
199+
200+
201+
### CUSTOM ###
202+
203+
# Because CRA uses an outdated version of Webpack which causes conflicts
204+
!/.env
205+
206+
# To share the recommended VSCode extensions
207+
!.vscode/extensions.json

.vscode/extensions.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"recommendations": [
3+
"apollographql.vscode-apollo",
4+
"dbaeumer.vscode-eslint",
5+
"esbenp.prettier-vscode",
6+
"mrmlnc.vscode-json5",
7+
"csstools.postcss"
8+
]
9+
}

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,38 @@
66

77
- [Node.js](https://nodejs.org/en/)
88

9-
v15.6.0 is confirmed to work.
9+
v15.6.0 on macOS Big Sur is confirmed to work.
1010

1111
## Getting Started
1212

1313
1. `git clone [email protected]:symptomizer/frontend.git`
1414
1. `cd frontend`
1515
1. `npm i`
16-
1. `npm run build`
16+
1. `npm run test`
17+
18+
This will ensure the project is in a good state. It performs linting and formatting, it builds the artifacts, and it runs the tests.
1719

1820
## Project Structure
1921

2022
This project is primarily a [Create React App](https://create-react-app.dev/). It uses [TypeScript](https://www.typescriptlang.org/) to aid the developer experience.
2123

2224
### React App
2325

24-
If you only need to run the React app, you can just run `npm run start`. It auto hot-reloads so is great for developing the UI.
26+
If you only need to run the React app, you can just run `npm run start`. This auto hot-reloads so is great for developing the UI.
27+
28+
The code can be found in `./src`. It uses [React Router](https://reactrouter.com/web/guides/quick-start) for navigation and [Apollo Client](https://www.apollographql.com/docs/react/) for data transport. The UI itself is predominately built with [Tailwind UI](https://tailwindui.com/).
2529

2630
## FAB
2731

2832
This project is enhanced as a [FAB](https://fab.dev/), which allows us to sprinkle in some server-side functionality. These plugins can be found in the `./api` folder. Right now, there's just a mock GraphQL server, but in the future, we could use this for user authorization etc.
2933

3034
## Testing
3135

32-
Pretty minimal at this point, but CRA comes with Jest testing built-in, so there's one example in `./src/App.test.tsx`.
36+
Pretty minimal at this point, but CRA comes with [Jest](https://jestjs.io/) built-in and there's one example in `./src/App.test.tsx`.
3337

3438
### Static Testing & Linting
3539

36-
[ESLint](https://eslint.org/) comes pre-setup with CRA, and [Prettier](https://prettier.io/) is setup with [`lint-staged`](https://github.com/okonet/lint-staged) and [`husky`](https://github.com/typicode/husky) so it be run automatically when you `git commit`.
40+
[ESLint](https://eslint.org/) comes pre-installed with CRA, and [Prettier](https://prettier.io/) is setup with [`lint-staged`](https://github.com/okonet/lint-staged) and [`husky`](https://github.com/typicode/husky) so it be run automatically when you `git commit` (along with the Jest tests).
3741

3842
## Deployment
3943

0 commit comments

Comments
 (0)