Merge pull request #11 from gskril/patch-1
de89eae0
Fix typos and example code in readme
1 file(s) · +5 −5
| 6 | 6 | ||
| 7 | 7 | ## Why bhvr? |
|
| 8 | 8 | ||
| 9 | - | While there are plenty of existing app building stacks out there, many of them are either bloated, outdated, or have too much of a vendor lock-in. bhvr is built with the opinion that you should be able to deploy your client or server in any environment while also keeping type saftey. |
|
| 9 | + | While there are plenty of existing app building stacks out there, many of them are either bloated, outdated, or have too much of a vendor lock-in. bhvr is built with the opinion that you should be able to deploy your client or server in any environment while also keeping type safety. |
|
| 10 | 10 | ||
| 11 | 11 | ## Features |
|
| 12 | 12 | ||
| 32 | 32 | ||
| 33 | 33 | ### Server |
|
| 34 | 34 | ||
| 35 | - | bhvr uses Hono as a backend API for it's simplicity and massive ecosystem of plugins. If you have ever used Express then it might feel familiar. Declaring routes and returning data is easy. |
|
| 35 | + | bhvr uses Hono as a backend API for its simplicity and massive ecosystem of plugins. If you have ever used Express then it might feel familiar. Declaring routes and returning data is easy. |
|
| 36 | 36 | ||
| 37 | 37 | ``` |
|
| 38 | 38 | server |
|
| 153 | 153 | ||
| 154 | 154 | ### Shared |
|
| 155 | 155 | ||
| 156 | - | The Shared package is used for anything you want to share between the Server and Client. This could be types or libraries that you use in both the enviorments. |
|
| 156 | + | The Shared package is used for anything you want to share between the Server and Client. This could be types or libraries that you use in both environments. |
|
| 157 | 157 | ||
| 158 | 158 | ``` |
|
| 159 | 159 | shared |
|
| 165 | 165 | └── tsconfig.json |
|
| 166 | 166 | ``` |
|
| 167 | 167 | ||
| 168 | - | Inside the `src/index.ts` we export any of our code from the folders so it's usabe in other parts of the monorepo |
|
| 168 | + | Inside the `src/index.ts` we export any of our code from the folders so it's usable in other parts of the monorepo |
|
| 169 | 169 | ||
| 170 | 170 | ```typescript |
|
| 171 | 171 | export * from "./types" |
|
| 237 | 237 | Types are automatically shared between the client and server thanks to the shared package and TypeScript path aliases. You can import them in your code using: |
|
| 238 | 238 | ||
| 239 | 239 | ```typescript |
|
| 240 | - | import { ApiResponse } from '@shared/types'; |
|
| 240 | + | import { ApiResponse } from 'shared/types'; |
|
| 241 | 241 | ``` |
|
| 242 | 242 | ||
| 243 | 243 | ## Learn More |
|