https://github.com/carlitorweb/gaterways-ui
REST service for storing and share information about Gaterways
https://github.com/carlitorweb/gaterways-ui
reactjs tailwindcss typescript vitejs
Last synced: 2 months ago
JSON representation
REST service for storing and share information about Gaterways
- Host: GitHub
- URL: https://github.com/carlitorweb/gaterways-ui
- Owner: carlitorweb
- Created: 2022-11-15T13:32:50.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-19T02:42:23.000Z (over 2 years ago)
- Last Synced: 2025-01-21T19:51:10.437Z (4 months ago)
- Topics: reactjs, tailwindcss, typescript, vitejs
- Language: TypeScript
- Homepage:
- Size: 418 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gaterways
REST service for storing and share information about Gaterways
## Tech Stack
**Client:** React, ViteJS, TailwindCSS, Typescript
**Server:** Node, Express, ORM PrimaJS, MongoDB Atlas, Typescript
## Requirements tasks completed
- [x] Create and Store the information of a Gaterway
- [x] Create and Store information of a Peripheral Device
- [x] Add a Peripheral Device to a Gaterway
- [x] Delete a Gaterway from the database
- [x] Validate the IPv4 field before store a Gaterway.
- [x] Show a error message to the user in case of a wrong IPv4.
- [x] Display information about all Gaterway stored
- [x] Display the amount of Peripheral Device each Gaterway stored have
- [x] Display the amount of Peripheral Device each Gaterway stored have
- [x] Provide a UI for the app
- [x] Check a Gaterway not have more than 10 Peripheral Device before add a new one to him
## Requirements tasks not completed due time
- [ ] Display information about all Peripheral Device stored
- [ ] Delete one or more Peripheral Device from a Gaterway
- [ ] Meaningful Unit tests (Jest was the choosen tool)
- [ ] An automated build
## To-do to improve
- [x] useImmerReducer for manage the main context-store
- [ ] Use React Query for our Fetch (https://tanstack.com/)
## Installation
**Note:** Need the gaterway-server running first
Now go to gaterways-ui folder and run:
```bash
npm install
```
When all dependency are installed, run the follow command:
```bash
npm run dev
```
The application UI will launch
