Skip to content

smarabattula/ubuntu-unity

Repository files navigation

ubuntu-unity

OpenAI DOI

MongoDB Express.js React NodeJS

NPM Vite TailwindCSS TypeScript JavaScript


Ubuntu Unity - Celebrating Black History and Pride

Overview

Welcome to Ubuntu Unity, a project dedicated to promoting and celebrating the rich traditional values and way of life of the Black community. Our goal is to highlight the essence of Ubuntu and foster unity within the community. A project, which is done as part of Hack NC State x MLH preserving black culture

Project Structure

Components

  • Login & SignUp Auth:

    • Implemented Web Authentication using MongoDB for a secure and personalized experience.
  • Common:

    • Integration of recommender functionality into the frontend to enhance user experience.
  • Contact:

    • Connect with us through the landing page for any inquiries or collaboration.
  • funFacts:

    • Enjoy entertaining facts and stories that celebrate the vibrant history.
  • Home:

    • Updated Home.jsx and API.js for an enriched quiz experience.
  • Pages:

    • Continuously updated pages to provide fresh content.
  • Recipe:

    • Discover and share traditional recipes that are an integral part of Black culture.
  • Recommender:

    • Explore recommended content tailored to your interests using ChatGPT API.
  • Righteous Reading:

    • Engage with a landing page that highlights literature promoting Black history and pride.
  • Weekly Quiz:

    • Participate in weekly quizzes to test your knowledge and learn more.
  • About:

    • Explore the background and purpose of Ubuntu Unity.

Contributing

We welcome contributions to Ubuntu Unity! If you have ideas, suggestions, or want to contribute code, please feel free to do so. Together, let's make Ubuntu Unity a platform that truly reflects and celebrates the diversity of the Black community.

How to Run

For Devs

  1. Clone the repository: git clone https://github.com/smarabattula/ubuntu-unity.git

  2. Navigate to the src directory: cd ubuntu-unity

  3. Install Node.js and npm

  4. Install dependencies using npm install package-lock.json

  5. Run the node backend server using node server.cjs

  6. Run the node backend server for database authentication using 'node auth.cjs'

  7. Run the frontend app server on a separate terminal using npm run dev