Merge branch 'web/doc/app' into development

apps/docs/pages/_meta.json

@@ -5,16 +5,7 @@
   "frontend": "Front-End",
   "backend": "Back-End",
   "builds": "Build",
-  "setup":"Setup",
-  "about": {
-    "title": "About",
-    "type": "page"
-  },
-  "contact": {
-    "title": "Contact ↗",
-    "type": "page",
-    "href": "https://twitter.com/shuding_",
-    "newWindow": true
-  }
+  "setup": "Setup",
+  "testing": "Tests"
 
 }

apps/docs/pages/backend.mdx

@@ -1 +1,99 @@
 # Back-End 
+WizePrompt Server side of the web application that is responsible of handling
+the database interactions and the server connection. The managment of the database is 
+done through Prisma Client and the created datbase is done by the PostgreSQL software application.
+
+## Backend-End Dependencies
+- [x] **Prisma** | Database Managment
+- [x] **PostgreSQL** | Open Source Database 
+
+## Back-End Section and Files
+
+### [Api Routes](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api)
+* [OpenAI IA language models](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/ai/openai)
+```
+POST /ai/openai/dalle
+POST /ai/openai/gpt-3.5-turbo
+POST /ai/openai/gpt-4
+POST /ai/openai
+```
+* [Authentication Auth0](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/auth/%5Bauth0%5D)
+```
+GET /auth/:auth0
+```
+* [User Conversations](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/conversations)
+```
+GET /conversations/user/:id
+PATCH /conversations/user/:id
+POST /conversations
+GET /conversations/:id
+PATCH /conversations/:id
+DELETE /conversations/:id
+PATCH /conversations/deactivate/:id
+```
+* [User Groups](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/groups)
+```
+GET /groups
+GET /groups/:id
+PATCH /groups/:id
+DELETE /groups/:id
+```
+* [User Keys](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/keys)
+```
+GET /keys/user/:id
+POST /keys
+PATCH /keys/:id
+DELETE /keys/:id
+```
+* [User Messages](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/messages)
+```
+GET /messages/conversation/:id
+POST /messages
+PATCH /messages/:id
+DELETE /messages/:id
+```
+* [IA language model](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/models)
+```
+GET /models
+GET /models/:id
+PATCH /models/:id
+```
+* [Parameters](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/params)
+```
+GET /params/conversation/:id
+POST /params
+PATCH /params/:id
+DELETE /params/:id
+```
+* [Providers](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/providers)
+```
+GET /providers
+GET /providers/:id
+PATCH /providers/:id
+```
+* [User Tags](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/tags)
+```
+GET /tags/user/:id
+GET /tags/conversation/:id
+POST /tags
+PATCH /tags/:id
+DELETE /tags/:id
+```
+* [Users](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/app/api/users)
+```
+GET /users
+GET /users/:id
+PATCH /users/:id
+DELETE /users/:id
+```
+
+### Web Application Prisma Database, Types & Library
+WizePrompt Prisma files and the database Prisma Squema
+* [Prisma](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/prisma)
+    * [Prisma Database Squema](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/blob/main/apps/web/prisma/schema.prisma)
+
+Back-End Types, Library & functions
+* [Types](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/lib)
+* [Library](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/types)
+
+

apps/docs/pages/builds/_meta.json

@@ -1,3 +1,5 @@
 {
+    "commands": "Build Instructions / Commands",
     "environment": "Environment Api Keys"
+
 }

apps/docs/pages/builds/commands.mdx

@@ -0,0 +1,7 @@
+# Build Instructions / Commands
+
+WizePrompt counts with Github Actions, which makes the process of build and commands totally automatic.
+When you merge any Github branch to the Main project, the **build, deployment & Release** are done by Github Actions.
+
+## CI/CD
+- [x] **Github Actions**

apps/docs/pages/coding/base.mdx

@@ -2,7 +2,7 @@
 
 Base Configuration
 
-```js filename="base.json" {1} copy
+```js filename="base.json" copy
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "display": "Default",

apps/docs/pages/coding/nextjs.mdx

@@ -2,7 +2,7 @@
 
 Nextjs Configuration
 
-```js filename="nextjs.json" {1} copy
+```js filename="nextjs.json" copy
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "display": "Next.js",

apps/docs/pages/coding/reactli.mdx

@@ -1,8 +1,8 @@
 ## React-Library
 
-React-Library Configuration
+React-Library Configuration 
 
-```js filename="react-library.json" {1} copy
+```js filename="react-library.json" copy
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "display": "React Library",

apps/docs/pages/frontend.mdx

@@ -1 +1,27 @@
-# Front-End
+# Front-End
+WizePrompt Client side and interactive part of the web application that 
+works with several front-end frameworks and UI components for the interface design.
+
+## Front-End Dependencies
+- [x] **Next.js 14** | Web Application Framework
+- [x] **Tailwind CSS** | Styling Framework
+- [x] **NextUI** | UI Components 
+- [x] **Shadcn/ui** | UI Components
+
+## Front-End Section and Files
+
+### Interface Components 
+- **[Admin Page](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/components/admin)**
+- **[User Page](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/components/user)**
+- **[Shared Components](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/components/shared)**
+- **[Login Auth0](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/components/login)**
+- **[UI Components](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/components/ui)**
+    - [button.tsx](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/blob/main/apps/web/components/ui/button.tsx)
+    - [codeblock.tsx](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/blob/main/apps/web/components/ui/codeblock.tsx)
+    - [icons.tsx](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/blob/main/apps/web/components/ui/icons.tsx)
+    - [skeleton.tsx](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/blob/main/apps/web/components/ui/skeleton.tsx)
+    - [slider.tsx](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/blob/main/apps/web/components/ui/slider.tsx)
+
+
+
+

apps/docs/pages/index.mdx

@@ -1,3 +1,4 @@
+[![wizeline-Logo11.png](https://i.postimg.cc/YqLG6XX5/wizeline-Logo11.png)](https://postimg.cc/6ywpwhxc)
 # Welcome to WizePrompt
 
 ## Project Overview
@@ -15,13 +16,15 @@ Project Administrator:
 David Gerardo Martínez
 
 Development Team:
-David Gerardo Martínez  - William Frank Monroy 
-María Eugenia Ontiveros - Jackeline Conant 
-Emilio Ortiz            - Rodrigo Rodriguez
+- David Gerardo Martínez  - William Frank Monroy 
+- María Eugenia Ontiveros - Jackeline Conant 
+- Emilio Ortiz            - Rodrigo Rodriguez
 
 Design Team:
-David Gerardo Martínez  - William Frank Monroy 
-Jackeline Conant
+- David Gerardo Martínez  - William Frank Monroy 
+- Jackeline Conant
 ``` 
 
 ## About this file
+The purpose of this WizePrompt Documentation Web Page is to provide an 
+setup instruction manual and show background information of WizePrompt.

apps/docs/pages/setup/_meta.json

@@ -1,4 +1,5 @@
 {
     "gitcode": "Git Code to Local System",
     "packages": "Dependency Packages and Tools"
+
 }

apps/docs/pages/setup/gitcode.mdx

@@ -1,6 +1,4 @@
-# Setup instructions
-
-## Fetching git code to local system
+# Fetching git code to local system
 
 Commands that will use Github tools to fetch WizePrompt git code to local system
 
@@ -22,7 +20,3 @@ git clone https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-te
 >   > git pull
 >   > ```
 > If previous commands were used the git code should be already updated and inside the local repository.
-
-
-
-## Commands / Instructions for starting a server / OS service required by the project to run etc

apps/docs/pages/setup/packages.mdx

@@ -1,4 +1,4 @@
-## Installing project specific dependency packages and tools
+# Installing project specific dependency packages and tools
 
 * **Pnpm package Manager**
 > Pnpm is an efficient package manager for Wizepropmt dependencies installation.
@@ -10,8 +10,6 @@
 >```js filename="TERMINAL" {1} copy
 > pnpm install
 >```
-> This specific command will appear, wait for it to end installing and test.
-
 > If all the dependencies are installed the system will respond with:
 >```js
 > Scope: all 6 workspace projects

apps/docs/pages/specifications.mdx

@@ -1,16 +1,27 @@
-# Project requirements and especifications
+# Project Requirements and Specifications
 
-## Requirements
+## Software Requirements
 
-Tools and Hardware Requirements Declaration
+- [x] Windows | macOS | Linux
+- [x] PostgreSQL Database
+- [x] Auth0 authentication tool
+- [x] Amazon Lightsail & S3 Bucket
 
-# Software Requirements
+## Hardware Requirements
 
-# Hardware Requirements
+- [x] Minimum 4 GB RAM
+- [x] Minimum 16 GB Available Disk Space
+- [x] Wifi Availability
+
+## Technical Specifications
+
+* WizePrompt is a React based project that uses **Next.js & Tailwind CSS** framework.
+* The Next.js code is deployed by the **Amazon Web Services(AWS) Lightsail**.
+* The storage of Openai Dall.E generated pictures is through by the **Amazon Web Services(AWS) S3 Bucket**.
+* _The AWS license is provided by WizeLine._
+* The Next.js application and the PostgreSQL database are compiled with the `pnpm dev` command.
 
-## Specifications
 
-Technical Specifications
 
 
 

apps/docs/pages/testing.mdx

@@ -1 +1,14 @@
-# Unit Testing or Basic testing steps
+# Unit Testing or Basic testing steps
+To unit test the web application of WizePrompt you will need to
+install the Framework first. This happens in the section **Setup/Dependency Packages and Tools**.
+
+## Unit Testing Dependencies 
+- [x] **Playwright** | Web testing Framework
+
+## Start testing the project
+WizePropmt already count with different types of test cases to use.
+These are inside the app repository [Tests](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/tree/main/apps/web/tests)
+> After positioning yourself inside this file, you can start finally testing WizePrompt with this command:
+> ```js filename="TERMINAL" {1} copy
+> pnpm test:ci
+> ```