CommuniCraft - Building Bridges Through Collaborative Craftsmanship.

CommuniCraft - a platform that connects individuals through collaborative craft projects, it connects people with the joy of hands-on creation and foster meaningful connections through collaborative craft projects. This platform, a backend API built with Node.js, was developed to provide a robust framework for user interaction, data collection, and facilitating the completion of craft projects.

Table of Contents

• Introduction
• Project Folders
• Features
• Technologies Used
• Getting Started
• API Documentation
• Testing
• Vision

Introduction

CommuniCraft serves as a robust backend API designed to handle craft projects data collection, user profile management, local partnership integration, community reporting, supporting companies , resources provision, seeing finished projects and benefiting from them. It's a platform aimed at fostering connections and creativity through collaborative craft projects.

Project Folders

Features

Main Features:

1. Project Library: A curated collection of craft projects ranging from beginner to advanced, categorized by skills, materials, and group size.
2. Skill Matching: Users create profiles showcasing their craft skills and interests, facilitating connections with others seeking collaborators.
3. Collaborative Planning: Integrated communication tools and project planning features allow teams to coordinate, share ideas, and assign tasks.
4. Resource Sharing: Users can list available materials and tools, promoting resourcefulness and reducing individual costs.
5. Showcase and Sharing:: The platform facilitates sharing finished projects, fostering community engagement, and inspiring others.
6. Local Partnership Integration: Connects users with local craft stores, workshops, and group artisans, and supporting companies, promoting local businesses and knowledge sharing.

Additional Features:

• User Privacy and Data Security: Implement stringent privacy and security measures to protect users' data, and there is Roles.
• Communication: bidirectional communication between all elements in the project, users, craftproject, workshops, groups, companies.
• Error Handling and Logging: The API must implement error handling and logging to help with debugging and troubleshooting.
• External API Integration: Utilized to enhance functionality and supplement data collection.

Technologies Used

• Node.js: Backend development platform.
• MySQL: Database for CRUD operations.
• Postman: API building, testing and documentation tool.
• Git: Version control system.
• Axios: making and managing HTTP requests.

Getting Started

To get started with CommuniCraft API, follow these steps:

1. Clone the repository: git clone https://github.com/yazansedih/CommuniCraft1.git
2. Install dependencies: npm install
3. Configure environment variables.
4. Setup the database using mysql ( sql code is inside database folder ).
5. Run the application: npm start

API Documentation

The API is fully documented using Postman. Access the documentation here.

Testing

Postman Testing Strategy

We have employed Postman for comprehensive API testing to ensure the functionality, reliability, and accuracy of the CommuniCraft platform. Our testing strategy involves:

Instructions for Testing Using Postman:

1. Import the provided Postman collection.
2. Run collection tests individually or perform a collection run to test various API endpoints.

Demo

click on the following link to watch the testing demo video.

Vision

CommuniCraft seeks to become a platform used in the work of most local and international projects, and to be a catalyst for change and development in this field by facilitating the formation of partnerships and linking all components of the projects.