farisfaikar / wayry

WAYRY (Short for Why Are You Repeating Yourself) is an app where you can track the speech patterns of a person!
https://wayry.vercel.app
MIT License
5 stars 9 forks source link
drizzle-orm hacktoberfest neondb nextauth nextjs shadcn-ui tailwind typescript

WAYRY πŸ—£οΈπŸ”„

Welcome to WAYRY (short for Why Are You Repeating Yourself), the app designed to track and analyze the repetitive speech patterns of your friends, colleagues, or anyone else you talk to! Whether you’re just curious or want to have some fun pointing out how often they repeat themselves, this app is your perfect tool. Not weird or useless at all, right?πŸ˜‰

πŸ“‹ Table of Contents

✨ Why Are You Repeating Yourself?

Try the App Now!

Explore WAYRY at: wayry.vercel.app

πŸ“± Features

1. Track Speech Patterns

2. Guest & User Modes

3. Personal Dashboard

4. Speech Data Analysis

5. Simple UI

πŸ’» Development Setup

Want to explore the code or contribute to the project? Here’s how you can run it locally:

1. Clone the Repository

git clone https://github.com/farisfaikar/wayry.git
cd wayry

2. Install Dependencies

npm install
# or
yarn install
# or
pnpm install
# or
bun install

3. Run the Development Server

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Note: The project was initially using next/font to optimize fonts, but due to some bugs, that feature was removed.

4. Open Your Local Development Site

Visit http://localhost:3000 in your browser to view and interact with the app.

Here’s the updated Project Structure section in the required format:

πŸ“‚ Project Structure

.
β”œβ”€β”€ app/                # Application core files
β”‚   β”œβ”€β”€ components/     # Reusable UI components
β”‚   β”œβ”€β”€ hooks/          # Custom React hooks
β”‚   β”œβ”€β”€ lib/            # Library and utility functions
β”‚   └── server/         # Backend server-side logic
β”œβ”€β”€ public/             # Static assets (e.g., images, logos)
β”œβ”€β”€ types/              # TypeScript types and interfaces
β”œβ”€β”€ .env.example        # Example of environment variables
β”œβ”€β”€ .eslintrc.js        # ESLint configuration file
β”œβ”€β”€ .gitignore          # Git ignore file
β”œβ”€β”€ .prettierrc.js      # Prettier configuration file
β”œβ”€β”€ CODE_OF_CONDUCT.md  # Code of conduct for contributors
β”œβ”€β”€ README.md           # Project README (this file)
β”œβ”€β”€ drizzle.config.ts   # Drizzle ORM configuration
β”œβ”€β”€ next.config.mjs     # Next.js configuration
β”œβ”€β”€ postcss.config.mjs  # PostCSS configuration
β”œβ”€β”€ tailwind.config.ts  # TailwindCSS configuration
β”œβ”€β”€ tsconfig.json       # TypeScript configuration
β”œβ”€β”€ package.json        # Project dependencies and scripts
└── package-lock.json   # Lockfile for project dependencies

πŸ› οΈ Technologies Used

Tool / Technology Purpose
Next.js Framework for building the app's frontend
Typescript Ensuring type safety and catching errors early
TailwindCSS Utility-first CSS framework for styling
NextAuth Authentication for handling user sessions
Shadcn/UI Accessible UI components for building the UI
NeonDB PostgreSQL database for efficient data storage
Drizzle ORM Lightweight ORM for database interactions
Vercel Hosting and deployment platform

🀝 Contributing

Contributions are always welcome! Feel free to open issues or submit pull requests on GitHub.

But... if you're reading this around Hacktoberfest season, maybe wait until then for some extra perks? πŸŽƒ

πŸ‘€ Author

Sarthak Sachdev

πŸ’¬ Got Feedback for Me?

I love receiving feedback! I’m always looking to improve my code and take up new innovative ideas to work on. So if you have any feedback, feel free to email me at:
πŸ“§ farisfaikar.r[at]gmail[dot]com

License

Copyright Β© 2021 farisfaikar.
MIT

Support

Please ⭐️ this repository if this project helped you makes you laugh! Happy coding! β˜ΊοΈπŸš€