feature(README): update repo README

TOPOFGR · Jun 6, 2024 · 3b4a47f · 3b4a47f
1 parent 0ab20bd
commit 3b4a47f
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -34,4 +34,19 @@ npm run dev
 cd ui-api
 npm install
 npm run start:dev
-```
+```
+
+
+## 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).
diff --git 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
+```
diff --git a/ui-api/README.md b/ui-api/README.md
@@ -1,27 +1,3 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
-</p>
-
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
-
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
-
 ## 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
+```