Brain Buzz is a dynamic web application designed to provide users with an engaging platform for discovering and interacting with content. This README outlines the key features and technologies utilized in the development of Brain Buzz.
- Search Functionality: Implemented robust search capabilities allowing users to efficiently navigate through the database.
- User Authentication: Established secure user authentication protocols for a personalized experience.
- Engagement Features: Integrated liking and saving functionalities to enhance user interaction and content bookmarking.
- Intuitive Design: Crafted a visually appealing and user-friendly interface to optimize the overall user experience.
- Next.js: Next.js is a React framework that enables server-side rendering, providing enhanced performance and SEO benefits.
- Tailwind CSS: Tailwind CSS is a utility-first CSS framework used for building custom designs quickly and efficiently.
- TypeScript: TypeScript is a statically typed superset of JavaScript, enhancing code quality and developer productivity.
- MongoDB: MongoDB is a NoSQL database used for scalable and flexible data storage.
- NextAuth: NextAuth is a library for authentication in Next.js applications, offering easy integration with various authentication providers.
The live version of Brain Buzz can be accessed here.
To run Brain Buzz locally, follow these steps:
- Clone the repository:
git clone https://github.com/your-username/brain-buzz.git - Navigate to the project directory:
cd brain-buzz - Create a
.env.localfile in the root directory of the project. - Add the following environment variables to the
.env.localfile:
NEXT_PUBLIC_TINY_EDITOR_API_KEY=
MONGO_URI=
PERPEX_API=
UPLOADTHING_SECRET=
UPLOADTHING_APP_ID=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
AUTH_SECRET=
NEXTAUTH_URL=
EMAIL_PASSWORD=
- Replace the values with your respective API keys, URIs, secrets, and passwords.
- Install dependencies:
npm install - Start the development server:
npm run dev
Contributions are welcome! If you'd like to contribute to Brain Buzz, please fork the repository and submit a pull request with your changes.