🖥️ WhiteBoard Platform

📋 Table of Contents

• Introduction
• Team
• Features
• Installation
• Usage
• Relative Documentation
• Contributing
• License
• Contact

📝 Introduction

Welcome to the WhiteBoard Platform repository! This project aims to provide an interactive whiteboard for collaborative work and educational purposes. Users can draw, annotate, and share their boards in real-time, making it an ideal tool for remote learning, brainstorming sessions, and team collaborations.

Note: This repository contains the client-side code for the WhiteBoard Platform. For the server-side code, please refer to the WhiteBoard-Server repository.

👥 Team

Full Name	Student ID
Trần Ngọc Đăng Khôi	ITCSIU21197
Trần Phương Quang Huy	ITCSIU21071

✨ Features

• Real-time Collaboration: Work together with others in real-time.
• Drawing Tools: Access a variety of drawing tools to annotate and highlight.
• Save and Load Boards: Save your boards and load them later.
• User Authentication: Secure login and registration system.
• Responsive Design: Works seamlessly on desktops, tablets, and mobile devices.

🚀 Installation

Prerequisites

Ensure you have the following installed on your local development environment:

• Node.js
• npm (Node Package Manager)

Steps

1. Clone the repository:

   git clone https://github.com/koitran14/WhiteBoard-Platform.git
   cd WhiteBoard-Platform

2. Install dependencies:

   npm install

3. Set up environment variables:

   Create a .env file in the root directory and add the following:

   NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_dWx0aW1hdGUtYW50ZWxvcGUtNzIuY2xlcmsuYWNjb3VudHMuZGV2JA
   CLERK_SECRET_KEY=sk_test_8igoqMArm6k6oPgsUXGrMtRVtwRpJ60I13s1oRREfN
   NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
   NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
   NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/
   NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/
   NEXT_PUBLIC_API_URL='http://localhost:8080'
   

4. Run the application:

   npm run dev

   The application will be running on http://localhost:3000.

📖 Usage

1. Register/Login: Create an account or log in using your credentials.
2. Create a Board: Start a new board by clicking on the "Create Board" button.
3. Collaborate: Invite others to your board using a shareable link.
4. Draw and Annotate: Use the drawing tools to create and edit your board.
5. Save and Load: Save your board for later use and load previously saved boards.

📚 Relative Documentation

• To get the server-side code, access this WhiteBoard-Server repository.
• Get our report HERE.
• Access our slide for presentation HERE.

🤝 Contributing

We welcome contributions from the community! To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add new feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

Please make sure to update tests as appropriate and adhere to the code style guidelines.

📄 License

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

📬 Contact

If you have any questions or feedback, feel free to reach out:

• GitHub Issues: Submit an issue
• Email: tndkhoi.work@gmail.com

Note: This project was developed as part of the curriculum at the School of Computer Science and Engineering, International University.