update README

This commit is contained in:
Brandon Egger 2023-03-27 17:48:05 -05:00
parent 3e67399d1a
commit aa310d9eae
2 changed files with 12 additions and 24 deletions

View File

@ -1,28 +1,16 @@
# Create T3 App
# Auditory Training Resources
<p align="center">
<img src="assets/atr_table.png" width="400" />
</p>
This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`.
## Purpose
There are many auditory training resources that often have unique requirements. A patient may require an Android application, or help with a specific skill. The patient may also already be at a specific skill level, and want a resource that is more challenging or easier depending on age group. The goal of this application is to provide an accessible website for patients and providers to easily find recommendations auditory training development resources based on their unique requirements.
## What's next? How do I make an app with this?
## Production Deployment
TODO
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.
## Local Deployment
TODO
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.
- [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)
## Learn More
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.
## API Access
Documentation and updates to our RPC backend API are planned for the future. As of now there is no official documentation for accessing our resources database. More information to come!

BIN
assets/atr_table.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 262 KiB