martin/doorman
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

add readmes for ui and schema
All checks were successful
Build and push image for doorman-homeassistant / docker (push) Successful in 32s
Details
Build and push Doorman UI / API / docker (push) Successful in 2m8s
Details
Build and push image for doorman-homeassistant / deploy-gitainer (push) Successful in 5s
Details

Browse Source
This commit is contained in:
Martin Dimitrov 2025-06-10 18:59:14 -07:00
parent 8e18bfd53e
commit f3863719b5
2 changed files with 19 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
packages/doorman-schema/README.md Normal file
View File

@ -0,0 +1,5 @@
# doorman-schema
WIP: this will be the home for all the zod schemas in Doorman. The reason to make it a separate package, is so that we can share base validations between doorman-ui and doorman-api.
Currently only home to the auth schemas.

47
packages/doorman-ui/README.md
View File

@ -1,46 +1,27 @@
# Getting Started with Create React App
# doorman-ui
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
The React frontend for Doorman.
## Available Scripts
## running locally
In the project directory, you can run:
NOTE: you should be running at least doorman-api before starting the UI
### `yarn start`
Install deps: `bun install`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
Start dev server
The page will reload if you make edits.\
You will also see any lint errors in the console.
`bun run start`
### `yarn test`
UI will be served on port 3005, visit the test door page http://localhost:3005?door=test
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
The UI proxies /api to localhost:8080 (doorman-api) running locally so make sure this is also running
### `yarn build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
# sample e2e testing with all components
you can do e2e testing with the UI by running doorman-api doorman-client and doorman-ui
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
visit http://localhost:3005?door=test&key=1234 and click through until reaching the buzzer part
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
in another tab simulate buzzer call to test buzzer with http://localhost:4500/buzzer-activated?From=6133163433
### `yarn eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
UI should show the door was unlocked. doorman-client should return `<Play>` tags to simulate pressing keys on the phone to allow access