Merge pull request #162 from wizelineacademy/development

Docs update
wizelineacademy · Dec 1, 2023 · 6d70461 · 6d70461
2 parents b804bb1 + c565a60
commit 6d70461
Show file tree

Hide file tree

Showing 22 changed files with 275 additions and 233 deletions.
diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml
@@ -40,10 +40,6 @@ jobs:
         run: |
           ls
 
-      # - name: Test
-      # run: |
-      #   pnpm test:ci --if-present
-
   Release:
     name: Release
     needs: [Build, DeployStagingWeb, DeployStagingDocs]
@@ -79,10 +75,6 @@ jobs:
         run: |
           cat apps/web/.env
 
-      # - name: Test
-      #   run: |
-      #     pnpm test --if-present
-
   DeployStagingWeb:
     name: Deploy to Staging Web
     permissions:
@@ -124,10 +116,6 @@ jobs:
         run: |
           cd apps/web && pnpm build
 
-      # - name: Stop server
-      #   run: |
-      #     sshpass -p "${{ secrets.LIGHTSAIL_SSH_PASS }}" ssh -o StrictHostKeyChecking=no [email protected] "cd apps/web && pm2 stop all"
-
       - name: Clean LightSail directory
         run: |
           sshpass -p "${{ secrets.LIGHTSAIL_SSH_PASS }}" ssh -o StrictHostKeyChecking=no [email protected] "rm -rf apps/web"
@@ -151,7 +139,7 @@ jobs:
 
       - name: Start server
         run: |
-          sshpass -p "${{ secrets.LIGHTSAIL_SSH_PASS }}" ssh -o StrictHostKeyChecking=no [email protected] "cd apps/web && pm2 start pnpm --name "web" -- start"
+          sshpass -p "${{ secrets.LIGHTSAIL_SSH_PASS }}" ssh -o StrictHostKeyChecking=no [email protected] "cd apps/web && pm2 stop web && pm2 delete web && pm2 start pnpm --name "web" -- start"
 
       - name: Remove web node_modules
         run: |
@@ -197,10 +185,6 @@ jobs:
         run: |
           cd apps/docs && pnpm build
 
-      # - name: Stop server
-      #   run: |
-      #     sshpass -p "${{ secrets.LIGHTSAIL_SSH_PASS }}" ssh -o StrictHostKeyChecking=no [email protected] "cd apps/docs && pm2 stop all"
-
       - name: Clean LightSail directory
         run: |
           sshpass -p "${{ secrets.LIGHTSAIL_SSH_PASS }}" ssh -o StrictHostKeyChecking=no [email protected] "rm -rf apps/docs"
@@ -220,7 +204,7 @@ jobs:
 
       - name: Start server
         run: |
-          sshpass -p "${{ secrets.LIGHTSAIL_SSH_PASS }}" ssh -o StrictHostKeyChecking=no [email protected] "cd apps/docs && pm2 start pnpm --name "docs" -- start -- -p 3001"
+          sshpass -p "${{ secrets.LIGHTSAIL_SSH_PASS }}" ssh -o StrictHostKeyChecking=no [email protected] "cd apps/docs && pm2 stop docs && pm2 delete docs && pm2 start pnpm --name "docs" -- start -- -p 3001"
 
       - name: Remove docs node_modules
         run: |

diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml
@@ -1,27 +1,27 @@
 name: Playwright Tests
 on:
   push:
-    branches: [ main, master ]
+    branches: [main]
   pull_request:
-    branches: [ main, master ]
+    branches: [main]
 jobs:
-  test:
+  TestE2E:
     timeout-minutes: 60
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
-      with:
-        node-version: 18
-    - name: Install dependencies
-      run: npm install -g pnpm && pnpm install
-    - name: Install Playwright Browsers
-      run: pnpm exec playwright install --with-deps
-    - name: Run Playwright tests
-      run: pnpm exec playwright test
-    - uses: actions/upload-artifact@v3
-      if: always()
-      with:
-        name: playwright-report
-        path: playwright-report/
-        retention-days: 30
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install dependencies
+        run: npm install -g pnpm && pnpm install
+      - name: Install Playwright Browsers
+        run: pnpm exec playwright install --with-deps
+      - name: Run Playwright tests
+        run: pnpm exec playwright test
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30
diff --git a/LICENCE b/LICENCE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Team Sam (William Frank Monroy Mamani, Jackeline Conant, David Gerardo Martínez, María Eugenia Ontiveros, Emilio Ortiz, Rodrigo Rodriguez)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,81 +1,26 @@
-# Turborepo starter
-
-This is an official starter Turborepo.
-
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest
-```
-
-## What's inside?
-
-This Turborepo includes the following packages/apps:
-
-### Apps and Packages
-
-- `docs`: a [Next.js](https://nextjs.org/) app
-- `web`: another [Next.js](https://nextjs.org/) app
-- `ui`: a stub React component library shared by both `web` and `docs` applications
-- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
-- `tsconfig`: `tsconfig.json`s used throughout the monorepo
-
-Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
-
-### Utilities
-
-This Turborepo has some additional tools already setup for you:
-
-- [TypeScript](https://www.typescriptlang.org/) for static type checking
-- [ESLint](https://eslint.org/) for code linting
-- [Prettier](https://prettier.io) for code formatting
-
-### Build
-
-To build all apps and packages, run the following command:
-
-```
-cd my-turborepo
-pnpm build
-```
-
-### Develop
-
-To develop all apps and packages, run the following command:
-
-```
-cd my-turborepo
-pnpm dev
-```
-
-### Remote Caching
-
-Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
-
-By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
-
-```
-cd my-turborepo
-npx turbo login
-```
-
-This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
-
-Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
-
-```
-npx turbo link
-```
-
-## Useful Links
-
-Learn more about the power of Turborepo:
-
-- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
-- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
-- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
-- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
-- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
-- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
+<a name="readme-top"></a>
+
+[![CICD](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/workflows/CICD/badge.svg)](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/actions?query=workflow:"CICD")
+[![GitHub release](https://img.shields.io/github/release/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02?include_prereleases=&sort=semver&color=E93D44)](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/releases/)
+[![License](https://img.shields.io/badge/License-MIT-E93D44)](#license)
+[![issues - itesm-socioformador-ago-dec-2023-team-02](https://img.shields.io/github/issues/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02)](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/issues)
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+
+  <h3 align="center">WizePrompt</h3>
+
+  <p align="center">
+    Enterprise Centralized AI LLM's Platform for Wizeliners
+    <br />
+    <a href="http://52.54.237.87:3001/"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="http://52.54.237.87:3000/">View Demo</a>
+    ·
+    <a href="https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/issues">Request Feature</a>
+  </p>
+</div>
diff --git a/apps/docs/README.md b/apps/docs/README.md
@@ -1,23 +1,15 @@
-# Nextra Docs Template
+# WizePrompt Docs
 
-This is a template for creating documentation with [Nextra](https://nextra.site).
+## Setup
 
-[**Live Demo →**](https://nextra-docs-template.vercel.app)
+This app is part of WizePrompt mono-repo, so you need to follow the instructions in the [main README](../README.md) to setup the project.
 
-[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app)
+## Tech Stack
 
-## Quick Start
-
-Click the button to clone this repository and deploy it on Vercel:
-
-[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false)
-
-## Local Development
-
-First, run `pnpm i` to install the dependencies.
-
-Then, run `pnpm dev` to start the development server and visit localhost:3000.
-
-## License
-
-This project is licensed under the MIT License.
+- [React](https://reactjs.org/)
+- [Next.js](https://nextjs.org/)
+- [Tailwind CSS](https://tailwindcss.com/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Markdown](https://www.markdownguide.org/)
+- [ESLint](https://eslint.org/)
+- [Prettier](https://prettier.io/)
diff --git a/apps/docs/pages/_meta.json b/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"
 
 }
diff --git a/apps/docs/pages/about.mdx b/apps/docs/pages/about.mdx
diff --git a/apps/docs/pages/backend.mdx b/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)
+
+