Skip to content

BedrockFrontiers/social-app

Repository files navigation

Social App Logo

Tidal Social App

Vercel Next.js JWT Media PostgreSQL

Welcome to Tidal, a new wave in social networking that combines simplicity with subtlety. Tidal is designed to offer a seamless, elegant experience, bringing people together in an environment that feels natural and fluid. Our platform emphasizes ease of use, meaningful interactions, and a community-driven approach.

Features

  • Intuitive Interface: A clean, minimalist design that prioritizes user experience.
  • Real-Time Updates: Stay connected with your friends and followers with instant updates.
  • Privacy-Focused: Your data is yours. We value and protect your privacy.
  • Customizable Profiles: Express yourself with profile options that suit your personality.
  • Open Source: Tidal is open to the community. You can contribute to its growth and development.
  • API: The API of Tidal is easily to use, with SDK support.
  • Creating Bots: You're free to create bots using the Tidal API with the same facility of Discord.

Resources

Contributing

Thank you for considering contributing to Tidal! We appreciate any help in improving our project, whether through fixing bugs, adding new features, or enhancing documentation. Your contributions help us build a better product for everyone. Check the CONTRIBUTING.md file for more details.

Environment Setup

To begin developing your social application, you will first need to set up the .env file. You can find an example configuration in the .env.example file.

Guidelines

To ensure that your contributions are of high quality and can be reviewed in a timely manner, please adhere to the following guidelines:

  1. Scope and Quality:

    • High-Impact Contributions: Focus on submitting issues and pull requests that significantly improve the project. Minor tweaks or superficial changes should be grouped together or combined with larger contributions.
    • Code Quality: Write clean, maintainable, and well-documented code. Follow the existing coding conventions and structure your commits logically.
  2. Issue Reporting:

    • Clear Descriptions: Provide detailed and clear descriptions of the issue. Include steps to reproduce the problem, expected behavior, and screenshots if applicable.
    • Check for Duplicates: Before submitting an issue, search the existing issues to ensure it hasn’t already been reported.
  3. Pull Requests:

    • Branching: Create a new branch for each contribution. Use descriptive branch names that reflect the feature or fix (e.g., fix/issue-123 or feature/user-auth).
    • Comprehensive Testing: Ensure that your code is fully tested. Write new tests for any new functionality and ensure all existing tests pass.
    • Commit Messages: Write clear and descriptive commit messages. Use the imperative mood (e.g., “Fix bug in user authentication”).
    • Documentation: Update any relevant documentation to reflect your changes. If your contribution adds new features, include examples and instructions for use.
  4. Code Review Process:

    • Responsiveness: Be prepared to address feedback from the maintainers. This may involve making changes to your code, adding more tests, or improving documentation.
    • Collaboration: Engage with reviewers and other contributors in a constructive and professional manner. If there are any disagreements, discuss them openly and seek consensus.
  5. Communication:

    • Engagement: Join discussions in the Discussions section to share ideas, seek feedback, or ask questions before starting significant work.

License

Tidal is licensed under the MIT License. See the LICENSE file for more details.

Forking Guidelines

Ensure your fork is up to date with the original repository. Test your changes thoroughly before submitting a pull request.