hkiame/KikuyuSphere

KikuyuSphere Language Learning Platform - Explore the Kikuyu language and culture through interactive lessons, real-time chat, and cultural immersion.

KikuyuSphere

KikuyuSphere is a platform that aims to bring the Kikuyu language and culture to the world. It provides resources, learning materials, and a community space for individuals interested in learning about and engaging with the Kikuyu language and culture.

Table of Contents

• Introduction
• Technologies Used
• Features
• Getting Started
• Future Plans
• Contributing
• License

Introduction

KikuyuSphere is developed with the intention of bridging the gap between the Kikuyu community and enthusiasts who want to learn and experience the language and culture. The platform offers various features such as user registration, authentication, learning resources, and more.

Technologies Used

• Frontend: React (TypeScript)
• Backend: Node.js (Express) with TypeScript
• Database: MySQL with Prisma ORM
• State Management: Redux Toolkit
• Authentication: JWT (JSON Web Tokens)
• Styling: Bootstrap

Features

• User registration and email confirmation
• Secure user login with JWT authentication
• User profile management and customization
• Comprehensive learning resources for Kikuyu language and culture
• [Future Feature] Real-time communication for users
• [Future Feature] Chat functionality for community interaction

Getting Started

To run the project locally, follow these steps:

1. Clone the repository:

2. Install dependencies for both frontend and backend: cd frontend npm install cd .. npm install

3. Create a .env file in the backend directory and set the necessary environment variables following .env.example.

4. Run the backend server:

• npm run start

5. Run the frontend development server:

• npm run frontend

6. Access the application in your browser at http://localhost:3000.

Future Plans

We are continuously working on enhancing KikuyuSphere. Future plans include:

• Implementing localization using i18next for multilingual support
• Adding real-time communication features for users
• Introducing chat functionality for community engagement
• Enhancing user profiles with additional customization options

Contributing

Contributions are welcomed! Feel free to open issues for feature requests or bug reports. If you'd like to contribute code, please fork the repository and submit pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Note: The entire project is a work in progress, and we appreciate your interest and patience as we develop KikuyuSphere into a valuable resource for the Kikuyu community and enthusiasts worldwide.