Skip to content

Jamie-Poeffel/Chipstok

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

220 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chipstok



Chipstok Logo

Stars Badge Forks Badge Issues Badge Pull Requests Badge

🚀 Description

Chipstok is a vibrant social media platform designed for sharing and discovering short-form videos. Imagine a place where creativity meets community, offering a seamless and interactive experience for users to upload, browse, and engage with captivating content. Built with a modern Vue 3 + TypeScript front-end and a robust REST-style back-end API, Chipstok delivers responsive performance and a clean, intuitive user experience. Dive into a world of endless entertainment and connect with creators from around the globe!


📥 How to Use

  1. Visit the Website: Navigate to Chipstok.
  2. Explore the Feed: Browse through the curated feed of short-form videos. Use the intuitive interface to like, comment, and share your favorite content.
  3. Create an Account: Click on the "Sign Up" button to create a new account. Fill in the required details and verify your email address.
  4. Log In: If you already have an account, click on the "Log In" button and enter your credentials.
  5. Upload Videos: Once logged in, click on the "Upload" button to share your own short-form videos. Add a compelling description and relevant tags to increase visibility.

Example: To upload a video, click the "Upload" button, select your video file, add a description like "Amazing sunset view! #sunset #nature," and then click "Submit."

  1. Customize Your Profile: Personalize your profile by adding a profile picture, bio, and links to your other social media accounts.
  2. Follow Creators: Discover and follow your favorite creators to stay updated with their latest content.

📖 Documentation

Detailed documentation is available to help you understand the architecture, components, and API endpoints of Chipstok.

  • Frontend (Vue 3 + TypeScript):

    • Located in the Chipsytok/src directory.
    • Key components include:
      • VideoFeed.vue: Displays the main feed of short videos.
      • UploadVideo.vue: Component for uploading new videos.
      • UserAuthentication.vue: Handles user registration, login, and authentication.
  • Backend (REST API):

    • Built using [insert backend framework/language].
    • Key API endpoints:
      • /api/videos: Handles video uploads, retrieval, and deletion.
      • /api/users: Manages user accounts and profiles.
      • /api/auth: Provides authentication and authorization services.

    Note: The full API documentation, including request and response schemas, can be found in the docs/api directory.

  • ER-Diagram:

    • The Entity Relationship Diagram provides a visual representation of the database schema.
    • Located in the docs/ER-Diagram.pdf.

For more in-depth information, please visit our Documentation.



👥 Contributors

We extend our heartfelt gratitude to the following contributors who have dedicated their time and expertise to make Chipstok a reality:


Jamie Poeffel

Backend Developer

Kush Srigiri

Frontend Developer

Alessio Huber

Mockup Creator

🎯 Key Contributions

  • Jamie Poeffel (Backend Developer):

    • Optimized database queries for faster response times.
    • Improved SQL queries to reduce execution time by 40%.
    • Added indexing to frequently queried columns.
    • Removed unnecessary joins to enhance performance.
  • Kush Srigiri (Frontend Developer):

    • Improved UI components for better accessibility and responsiveness.
    • Designed and implemented Sign Up and Login pages.
    • Created a consistent color palette and modern layout.
    • Refactored styles for maintainability and scalability.
  • Alessio Huber (Mockup Creator):

    • Created detailed ER-Diagram for better structure and planning.
    • Enhanced mockup designs to support visualization and time management.

🤝 Collaboration

ChipslyFans Collab

We proudly collaborated with ChipslyFans – an exciting parallel project that shares the same spirit of creativity and community.
Check out their amazing work here: chipslyfans.bbzwinf.ch



📜 License

This project is licensed under the MIT License.

Add information about the usage if needed. For example,

This software is open source and available under the MIT License. See the LICENSE file for more information.

💡 We appreciate all contributions! Feel free to submit a PR or open an issue. 🎉

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •