Pocket Preschool

At Pocket Preschool, we understand the importance of a strong partnership between parents and educators in fostering a child's growth. Our innovative platform goes beyond traditional education, offering a seamless and interactive experience for both parents and teachers.

For Parents:

Upcoming Events at Your Fingertips: Stay informed about all the exciting events happening at Pocket Preschool. Our platform provides a comprehensive calendar of upcoming activities, celebrations, and important dates, allowing you to plan ahead and actively participate in your child's educational journey.

Chat with Teachers: Connect with your child's educators in real-time through our secure and convenient chat feature. Whether you have a quick question, want updates on your child's progress, or simply wish to share insights, our chat platform ensures open communication between you and the teachers.

Class Activities Updates: Wondering what your child is exploring in the classroom? Receive regular updates on class activities directly on the platform. From art projects to educational games, you'll have a front-row seat to your child's daily adventures, creating opportunities for meaningful conversations at home.

For Teachers:

Upcoming Events Management: Plan, organize, and communicate upcoming events effortlessly. Teachers can easily update the event calendar, ensuring that parents are well-informed about school functions, parent-teacher meetings, and special occasions.

Instant Communication with Parents: Teachers, empower your teaching experience by having direct and instant communication channels with parents. Whether it's sharing positive moments, addressing concerns, or providing timely updates, our chat feature allows you to build a strong and collaborative relationship with parents.

Class Activities Showcase: Showcase the vibrancy of your classroom! Keep parents engaged by updating class activities regularly. Share photos, descriptions, and the educational benefits of each activity, fostering a sense of involvement and understanding of their child's learning experiences.

At Pocket Preschool, we believe that a connected community enhances a child's educational journey. Our platform acts as a bridge, bringing teachers and parents together to create a supportive environment for every child to thrive.

Experience the Power of Connection at Pocket Preschool - Where Learning and Communication Unite!

Table of Contents

• Pocket Preschool
  • Introduction
  • Features
  • Getting Started
    • Prerequisites
    • Installation
  • Usage
  • Folder Structure
  • Contributing
  • Acknowledgments

Introduction

Embark on an exciting educational journey with Pocket Preschool, a revolutionary platform designed to enhance the way parents, teachers, and students engage with education. At Pocket Preschool, we believe in fostering a dynamic and collaborative learning environment that seamlessly integrates the classroom and home.

Our platform offers a host of features tailored to meet the unique needs of parents, teachers, and students. From real-time communication to event updates and class activities, Pocket Preschool is your go-to destination for a holistic educational experience.

Features

1. Instant Communication: Parents and teachers can connect effortlessly through our secure chat feature. Share updates, discuss progress, and stay connected in real-time.

2. Upcoming Events: Stay in the loop with all school events, parent-teacher meetings, and special occasions. Our comprehensive calendar ensures you never miss an important date.

3. Class Activities Showcase: Explore the exciting world of your child's classroom activities. Teachers can share photos, descriptions, and the educational significance of each activity, providing valuable insights into your child's learning journey.

Join us at Pocket Preschool and discover the power of a connected educational

Getting Started

Step 1: Explore Your Dashboard Once you've signed up, take a moment to explore your dashboard. This is your central hub for all things pocket preschool. Familiarize yourself with the layout and navigation options.

Step 2: Customize Your Profile Personalize your profile to make your pocket preschool experience unique. Upload a profile picture, update your contact information, and set your preferences from the profile settings.

Step 3: Connect with Others If your platform involves social interaction or networking, start connecting with others. Search for friends, colleagues, or other users you'd like to connect with, and send them friend requests.

Step 4: Complete Your Profile For a comprehensive experience, consider completing your profile. Add relevant details, skills, or interests that will help others get to know you better.

Step 5: If there's a standout feature that defines your product or service, provide detailed instructions on how users can leverage it. Whether it's chatting with teachers, checking upcoming events, or managing class activities, outline the steps to make the most of it.

Congratulations! You're now ready to dive into the world of [Your Product/Service Name]. If you have any questions along the way, don't hesitate to reach out to our support team. Happy exploring!

Prerequisites

Backend

• Visual Studio Code
• Express
• Bcrypt
• Cli
• Cors
• Dotenv
• Eslint
• JSONwebtoken
• Pg
• Sequelize
• Sequelize-cli
• Socket.io

Installation

Step-by-step instructions on how to install and set up your project.

# Example commands
npm i
npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console. tester

Usage

1. Installation: Before you begin, ensure that you have the following software installed on your system:

• Node.js (version 12 or higher)
• Git

Clone the repository to your local machine:

git clone https://github.com/misticalmaqe/PocketPreschool_Backend.git

Install project dependencies:

cd Frontend
npm install

2. Configuration Edit the configuration file (config.json) to set your preferences:

{
  "apiKey":"your-api-key",
  "username":"your-username"
}

3. Running the Application: Start the application using the following command:

npm start

Visit http://localhost:3000 in your web browser to access the application.

Detail feature

4. Usage Examples: a. Feature 1 - Chatting with Teachers:

• Navigate to the "Chat" section.
• Select the teacher you want to chat with.
• Start typing your message in the chatbox and press Enter to send.

b. Feature 2 - Upcoming Events:

• Go to the "Events" tab to view upcoming events.
• Click on an event to get more details.

c. Feature 3 - Class Activities for Parents:

• Visit the "Activities" section to stay updated on class activities.
• Filter activities based on your child's class.

5. Contributing: If you'd like to contribute to the project, follow these steps:

• Fork the repository on GitHub.
• Create a new branch for your feature: git checkout -b feature-name
• Commit your changes: git commit -m 'Add new feature'
• Push to the branch: git push origin feature-name
• Open a pull request on the GitHub repository

Feature: Real-time Communication

Overview:

ocket Preschool provides a robust real-time communication feature to facilitate seamless interaction between teachers and parents.

Key Components:

1. Chat with Teachers:

• Parents can initiate instant chat sessions with their child's teachers.
• Teachers can respond promptly to parents' queries and provide updates on their child's progress.

2. Upcoming Events:

• Parents have access to a calendar displaying upcoming school events, ensuring they stay informed about important dates.
• Teachers can update and add events, ensuring parents are aware of school activities.

3. Class Activities:

• Teachers can share details about ongoing and upcoming class activities, providing parents with insights into their child's daily learning experiences.
• Parents can view a timeline of class activities, fostering transparency and engagement.

Benefits:

• Improved Parent-Teacher Communication:

  • Enhances communication channels between parents and teachers, fostering a collaborative learning environment.

• Parental Engagement:

  • Keeps parents actively involved in their child's education by providing real-time updates and insights.

• Event Awareness:

  • Ensures parents are well-informed about upcoming events, reducing the likelihood of missed school activities.

• Transparent Learning Experience:

  • Provides a transparent view of class activities, allowing parents to understand and participate in their child's educational journey.

How to Use:

1. Chat with Teachers:

• Navigate to the "Chat" section in the application.
• Select the teacher you want to communicate with and start a chat.

2. Upcoming Events:

• Visit the "Events" or "Calendar" section in the application.
• View a list of upcoming events, along with details and timings.

3. Class Activities:

• Explore the "Class Activities" section to see ongoing and upcoming activities.
• Teachers can update activities, and parents can view the details.

Integration:

The real-time communication feature integrates with the existing Pocket Preschool platform, ensuring a seamless user experience.

Feel free to customize the content based on the specific features and functionalities of Pocket Preschool.

Folder Structure

• Pocket-Preschool-Backend
  • config
    • database.js
  • controller
    • baseController.js
    • chatController.js
    • classActivityController.js
    • newLetterController.js
    • teacherClassController.js
    • usersController.js
  • db
    • migration
      • 20231204072222-users.js
      • 20231204081144-class-activities.js
      • 20231204082757-children.js
      • 20231204084726-news_letters.js
      • 20231204085620-chat.js
      • 20231206050630-sessions_table.js
      • 20231208062149-teacher_classes.js
    • models
      • chat.js
      • chatRoom.js
      • child.js
      • classActimgs.js
      • classActivity.js
      • index.js
      • newImgs.js
      • newLetter.js
      • sessionTable.js
      • teacherClass.js
      • users.js
    • seeders
      • 20231204100116-users.js
      • 20231204130657-children.js
      • 20231204134632-class_activities.js
      • 20231204142954-news_letter.js
      • 20231204144931-chat_rooms.js
      • 20231208065935-teacher_classes.js
  • middlewares
    • jwtAuth.js
  • node_modules
  • routers
    • chatRouter.js
    • classActivityRouter.js
    • newLetterRouter.js
    • teacherRouter.js
    • usersRouter.js
  • .env
  • .env.sample
  • .gitignore
  • .sequelizerc
  • index.js
  • LICENSE
  • package-lock.json
  • package.json
  • Procfile
  • ReadMe.md

Contribution

Join Us in Shaping the Future of Pocket Preschool

Your input is essential to the continual enhancement of Pocket Preschool. We extend an invitation for you to contribute, sharing your insights and expertise to make Pocket Preschool an even more powerful and efficient password management solution.

About Pocket Preschool:

Originally conceived during the Rocket Academy FTBC13 Bootcamp, Pocket Preschool has grown into a comprehensive solution thanks to the tireless efforts of contributors like you. We want to express our gratitude to:

Ignatius Tan Jaipal Singh

Your Contribution Matters:

1. Insights and Feedback: Share your thoughts and suggestions to help us refine and improve Pocket Preschool. Your unique perspective can identify areas of improvement and innovation.

2. Bug Reporting: If you encounter any technical issues or glitches, let us know. Your attention to detail can aid our development team in maintaining a seamless user experience.

3. Spread the Word: Help us expand our community by sharing your positive experiences. Whether through social media, reviews, or word of mouth, your advocacy is instrumental in reaching a broader audience.

4. Feature Enhancement: Propose new features or improvements that can elevate the functionality of Pocket Preschool. Your ideas can contribute to making it an even more user-friendly and effective tool.

Your contribution, regardless of size, is a valuable part of the Pocket Preschool journey. Together, let's shape an innovative and reliable solution for password management.

Thank you for being a part of our collaborative effort!

Acknowledgments

In reflection of our journey, we extend heartfelt gratitude to Foong Leung, whose unwavering assistance has been integral to the success of our entire project. Foong has been a dependable presence, offering support not only for the fundamental aspects of our endeavor but also guiding us through the intricacies of our most challenging issues.

Our project's completion is a testament to Foong's continuous dedication, providing invaluable help and ensuring that we navigated through every phase successfully. It is with sincere appreciation that we acknowledge Foong Leung's constant aid, which has been the cornerstone of our achievements.

To Foong Leung, we express our deepest THANK YOU for your unwavering commitment and support throughout our journey. Your contributions have been indispensable, and we are truly grateful for everything you have assisted us with.