Skip to content

Commit

Permalink
📝 fancy readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Triginarsa committed Jun 29, 2023
1 parent 879910f commit a2a22f3
Showing 1 changed file with 31 additions and 17 deletions.
48 changes: 31 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,42 @@
# Create T3 App

This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`.
# Twiji: Because Who Needs Words When You Have Emojis? 🤔🎉🚀

## What's next? How do I make an app with this?
Welcome to Twiji, your new favorite social network! Who said communication needed to be complicated? With Twiji, we're stripping things back and going straight to the heart of modern communication—emojis! 🖋️⚔️😄

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.
Twiji is your beloved Twitter, but with a dash of fun. What's the fun part? You can't tweet words, only emojis! Why bother with a 280 character limit when you could express your feelings with a simple 😂 or 🙌 or 🍕?

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.
Feeling sad 😢? Overjoyed 🥳? Puzzled 🤷‍♂️? Express it all in emojis on Twiji. Break the language barriers and connect with people from around the globe in the most entertaining way possible—through the universal language of emojis!

- [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)
## Tech Stack 😎💻

## Learn More
This application is built using the rock-solid T3 Stack:

To learn more about the [T3 Stack](https://create.t3.gg/), take a look at the following resources:
* Next.js: Because we love a good React framework for JavaScript single-page applications.
* NextAuth.js: Ensuring your emoji communications remain secure.
* Prisma: Our magic wand for handling databases.
* Tailwind CSS: Giving our emojis a stylish home.
* tRPC: Building typesafe APIs because even emojis deserve type safety.

- [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
## CI Workflow 🔄

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

## How do I deploy this?
* Installing dependencies: Ensuring our emoji machine never stops.
* Type checking: Keeping our TypeScript in check.
* Linting: Because clean code = happy code.
* Printing environment variables: Echoing our love for the environment.

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.
## Components 🧩

Our app comprises several key components:

* `PageLayout`: The canvas where our emojis come to life.
* `LoadingSpinner` and `LoadingPage`: Our way of saying "Hold on, your emojis are coming!"

## Getting Started 🚀

Ready to join the emoji revolution? Just clone the repository, install the dependencies, and start the server. Welcome to the world of wordless communication!

## Check It Out 👀

Experience the emoji magic firsthand at [Twiji](https://twiji.vercel.app/). Get ready to enter a world where emojis reign supreme!

0 comments on commit a2a22f3

Please sign in to comment.