From 40b68902f7a48e482a6ee65bfd876df1529a30e5 Mon Sep 17 00:00:00 2001 From: Vojtech Mares Date: Sun, 25 Jun 2023 16:08:45 +0200 Subject: [PATCH] docs: add project's README and move default README --- README.create-t3-gg.md | 28 ++++++++++++++++++++++++++++ README.md | 29 ++++------------------------- 2 files changed, 32 insertions(+), 25 deletions(-) create mode 100644 README.create-t3-gg.md diff --git a/README.create-t3-gg.md b/README.create-t3-gg.md new file mode 100644 index 0000000..fba19ed --- /dev/null +++ b/README.create-t3-gg.md @@ -0,0 +1,28 @@ +# Create T3 App + +This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`. + +## What's next? How do I make an app with this? + +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. + +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. diff --git a/README.md b/README.md index fba19ed..4875c1e 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,7 @@ -# Create T3 App +# backoffice -This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`. +A small application serving as a freelancer's backoffice. -## What's next? How do I make an app with this? +A single source of truth. Currently an experiment. -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. - -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. +The idea to have all training data source here and not as a part of a monorepo, is mostly laziness since I do not think monorepo tooling such as [Turborepo](https://turbo.build/repo) is quite ready and also it brings certain challenges with building etc. My target platform for this project is a small Kubernetes cluster.