Skip to content
This repository has been archived by the owner on Mar 13, 2024. It is now read-only.

Commit

Permalink
docs(client): README
Browse files Browse the repository at this point in the history
  • Loading branch information
Pixselve committed Feb 3, 2024
1 parent 06d1da4 commit 34d5821
Showing 1 changed file with 13 additions and 21 deletions.
34 changes: 13 additions & 21 deletions packages/client/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,20 @@
# Create T3 App
# @viper-vortex/client

This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`.
This package is the client-side component of the Viper Vortex project. It handles the user interface, user interactions, and communication with the server-side component.

## What's next? How do I make an app with this?
## Installation

We try to keep this project as simple as possible, so you can start with just the scaffolding we set up for you, and add additional things later when they become necessary.
You can install this package by cloning the repository and running the following command in the `packages/client` directory:

If you are not familiar with the different technologies used in this project, please refer to the respective docs. If you still are in the wind, please join our [Discord](https://t3.gg/discord) and ask for help.
```bash
npm install
```

- [Next.js](https://nextjs.org)
- [NextAuth.js](https://next-auth.js.org)
- [Prisma](https://prisma.io)
- [Tailwind CSS](https://tailwindcss.com)
- [tRPC](https://trpc.io)
## Usage

## Learn More
To start the client, use the following command:

To learn more about the [T3 Stack](https://create.t3.gg/), take a look at the following resources:

- [Documentation](https://create.t3.gg/)
- [Learn the T3 Stack](https://create.t3.gg/en/faq#what-learning-resources-are-currently-available) — Check out these awesome tutorials

You can check out the [create-t3-app GitHub repository](https://github.com/t3-oss/create-t3-app) — your feedback and contributions are welcome!

## How do I deploy this?

Follow our deployment guides for [Vercel](https://create.t3.gg/en/deployment/vercel), [Netlify](https://create.t3.gg/en/deployment/netlify) and [Docker](https://create.t3.gg/en/deployment/docker) for more information.
```bash
npm run build
npm run start
```

0 comments on commit 34d5821

Please sign in to comment.