Welcome to teosd-gui (Graphical User Interface) designed to complement the existing teos-cli (Command-Line Interface) functionality.
While the CLI provides powerful command-based operations, Admins were faced with the task of manually interpreting the results and working with text-based outputs, making the data analysis process cumbersome and time-consuming.
To bridge this gap and enhance the user experience this GUI is developed
-
Install dependencies : run
npm run install:allto install all the dependencies for backend, frontend and the project directory. -
You can also find the scripts for separate installations in the
package.jsonfile in the root directory
- create a
.envfile in the backend folder and copy content from.env.example
- create a
.envfile in the env directory in frontend folder and copy content from.env.example
- Start the project with command
npm startin the root directory - To run only backend use
npm run start:backend - To run only frontend use
npm run start:frontend
- The server will start at Port
5000, if u want to change the port change in the env file in the backend folder
- The server will start at Port
3000, if you want to change the port change in thevite.config.tsfile in the frontend folder
- The unit tests have been completed and to run them
npm run test:unitin the backend folder - The E2E tests have been completed and to run them
npm run test:e2ein the backend folder
Base url = http://localhost:5000/api/v1/cli , change the port number if required
-
GET
/tower-info- Will get the info about the tower -
GET
/users- Will get all registered users -
GET
/get-user/:public_key- Will get the info of the user with user public key -
GET
/appointments- Will get all the appointments in the tower -
GET
/appointments/:locator- Will get the appointments with the given locator -
GET
/stop-tower- Will shut down the tower