From 3b4a47fddad19d62645ff51a338a63be25999ca6 Mon Sep 17 00:00:00 2001 From: Franco Galeano Date: Thu, 6 Jun 2024 18:34:27 -0300 Subject: [PATCH] feature(README): update repo README --- README.md | 17 ++++++++++++++- my-web/README.md | 3 ++- ui-api/README.md | 56 ++++++++++++++++-------------------------------- 3 files changed, 37 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index daf8d3f..b8298d8 100644 --- a/README.md +++ b/README.md @@ -34,4 +34,19 @@ npm run dev cd ui-api npm install npm run start:dev -``` \ No newline at end of file +``` + + +## Support +Want to contribute yourself? Just upluad a pull request! + +## Stay in touch + +- Author - [Franco Galeano](https://www.linkedin.com/in/franco-galeano-609171161/) +- Github - [@TOPOFGR](https://github.com/TOPOFGR) +- Twitter / 𝕏 - [@TOPOFGRdev](https://x.com/TOPOFGRdev) + + +## License + +BDUI-DEMO is [MIT licensed](LICENSE). \ No newline at end of file diff --git a/my-web/README.md b/my-web/README.md index 79595f7..fc1a4f7 100644 --- a/my-web/README.md +++ b/my-web/README.md @@ -15,7 +15,7 @@ npm run dev Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. ## Scaffolding - +``` src/ β”œβ”€β”€ app/ # All the pages (Next.js logic) β”‚ └── page.tsx # Home page @@ -28,3 +28,4 @@ src/ β”‚ └── componentMap.ts # The `Map` were all the components need to be defined before being used by the `Renderer` component β”‚ └── types.ts # All the custom typings +``` \ No newline at end of file diff --git a/ui-api/README.md b/ui-api/README.md index 00a13b1..fd6e2c7 100644 --- a/ui-api/README.md +++ b/ui-api/README.md @@ -1,27 +1,3 @@ -

- Nest Logo -

- -[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 -[circleci-url]: https://circleci.com/gh/nestjs/nest - -

A progressive Node.js framework for building efficient and scalable server-side applications.

-

-NPM Version -Package License -NPM Downloads -CircleCI -Coverage -Discord -Backers on Open Collective -Sponsors on Open Collective - - Support us - -

- - ## Description [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. @@ -58,16 +34,22 @@ $ npm run test:e2e $ npm run test:cov ``` -## Support - -Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). - -## Stay in touch - -- Author - [Kamil MyΕ›liwiec](https://kamilmysliwiec.com) -- Website - [https://nestjs.com](https://nestjs.com/) -- Twitter - [@nestframework](https://twitter.com/nestframework) - -## License - -Nest is [MIT licensed](LICENSE). +## Scaffolding +``` +src/ +β”œβ”€β”€ exceptions/ # Custom exceptions +β”‚ └── BadRequest.tsx # First custom exception +β”‚ +β”œβ”€β”€ templates/ # All the JSONs related to the UI templates +β”‚ └── home/ # Home page JSONs +β”‚ +β”œβ”€β”€ app.controller.ts # Controller layer for the first endpoints +β”‚ # `getHello` first endpoint for a "Hello World" response +β”‚ # `getHomePage` endpoint that uses the getHomePage service +β”‚ # sanitizes endpoint before calling the service +β”‚ +β”œβ”€β”€ app.service.ts # Service layer of the first controller +β”‚ # `getHomePage` service returns a JSON depending on the country received +β”‚ +└── types.ts # All the custom typings +```