-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'app/docs/readme' into development
- Loading branch information
Showing
4 changed files
with
71 additions
and
153 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> | ||
|
|
||
| [](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/actions?query=workflow:"CICD") | ||
| [](https://github.com/wizelineacademy/itesm-socioformador-ago-dec-2023-team-02/releases/) | ||
| [](#license) | ||
| [](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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
|
||
| [](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/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/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,17 @@ | ||
| --- | ||
| name: Vercel Postgres + Prisma Next.js Starter | ||
| slug: postgres-prisma | ||
| description: Simple Next.js template that uses Vercel Postgres as the database and Prisma as the ORM. | ||
| framework: Next.js | ||
| useCase: Starter | ||
| css: Tailwind | ||
| database: Vercel Postgres | ||
| deployUrl: https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fexamples%2Ftree%2Fmain%2Fstorage%2Fpostgres-prisma&project-name=postgres-prisma&repository-name=postgres-prisma&demo-title=Vercel%20Postgres%20%2B%20Prisma%20Next.js%20Starter&demo-description=Simple%20Next.js%20template%20that%20uses%20Vercel%20Postgres%20as%20the%20database%20and%20Prisma%20as%20the%20ORM.&demo-url=https%3A%2F%2Fpostgres-prisma.vercel.app%2F&demo-image=https%3A%2F%2Fpostgres-prisma.vercel.app%2Fopengraph-image.png&stores=%5B%7B"type"%3A"postgres"%7D%5D | ||
| demoUrl: https://postgres-prisma.vercel.app/ | ||
| relatedTemplates: | ||
| - postgres-starter | ||
| - postgres-kysely | ||
| - postgres-sveltekit | ||
| --- | ||
| # WizePrompt Web | ||
|
|
||
| # Vercel Postgres + Prisma Next.js Starter | ||
| ## Setup | ||
|
|
||
| Simple Next.js template that uses [Vercel Postgres](https://vercel.com/postgres) as the database and [Prisma](https://prisma.io/) as the ORM. | ||
| 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. | ||
|
|
||
| ## Demo | ||
| ## Tech Stack | ||
|
|
||
| https://postgres-prisma.vercel.app/ | ||
|
|
||
| ## How to Use | ||
|
|
||
| You can choose from one of the following two methods to use this repository: | ||
|
|
||
| ### One-Click Deploy | ||
|
|
||
| Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=vercel-examples): | ||
|
|
||
| [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fexamples%2Ftree%2Fmain%2Fstorage%2Fpostgres-prisma&project-name=postgres-prisma&repository-name=postgres-prisma&demo-title=Vercel%20Postgres%20%2B%20Prisma%20Next.js%20Starter&demo-description=Simple%20Next.js%20template%20that%20uses%20Vercel%20Postgres%20as%20the%20database%20and%20Prisma%20as%20the%20ORM.&demo-url=https%3A%2F%2Fpostgres-prisma.vercel.app%2F&demo-image=https%3A%2F%2Fpostgres-prisma.vercel.app%2Fopengraph-image.png&stores=%5B%7B"type"%3A"postgres"%7D%5D) | ||
|
|
||
| ### Clone and Deploy | ||
|
|
||
| Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [pnpm](https://pnpm.io/installation) to bootstrap the example: | ||
|
|
||
| ```bash | ||
| pnpm create next-app --example https://github.com/vercel/examples/tree/main/storage/postgres-prisma | ||
| ``` | ||
|
|
||
| Once that's done, copy the .env.example file in this directory to .env.local (which will be ignored by Git): | ||
|
|
||
| ```bash | ||
| cp .env.example .env.local | ||
| ``` | ||
|
|
||
| Then open `.env.local` and set the environment variables to match the ones in your Vercel Storage Dashboard. | ||
|
|
||
| Next, run Next.js in development mode: | ||
|
|
||
| ```bash | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=vercel-examples) ([Documentation](https://nextjs.org/docs/deployment)). | ||
| - [React](https://reactjs.org/) | ||
| - [Next.js](https://nextjs.org/) | ||
| - [Prisma](https://www.prisma.io/) | ||
| - [PostgreSQL](https://www.postgresql.org/) | ||
| - [Tailwind CSS](https://tailwindcss.com/) | ||
| - [TypeScript](https://www.typescriptlang.org/) | ||
| - [Playwright](https://playwright.dev/) | ||
| - [ESLint](https://eslint.org/) | ||
| - [Prettier](https://prettier.io/) |