Skip to content

elviraIv/social-sphere-app

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Social Sphere App

This README provides information about a social media application, including features, installation instructions, usage guidelines, and more.
Explore the docs Β»

View Demo Β· Report Bug Β· Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Logo

(back to top)

Built with:

  • React JS;
  • React Query
  • Vite;
  • TypeScript;
  • TailwindCSS;
  • Shadcn/UI;
  • Appwrite;

(back to top)

Getting Started

Overview

Social Sphere is an awesome social media platform designed to bring people and communities from all corners of the globe together! It's a versatile space where you can share your adventures, connect with folks, and create truly awesome relationships! πŸ˜„πŸŒπŸš€

Motivation

Our mission is all about crafting a social media platform that's super friendly. We totally believe in making the online world a welcoming space where you can share your stories and passions without any fuss or hassle. πŸ˜ŠπŸŒŸπŸ’¬

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Get a free API Key at https://appwrite.io/
  2. Clone the repo
    git clone https://github.com/elviraIv/social-sphere-app.git
  3. Install NPM packages
    npm install
  4. Enter your API in config.js
    const API_KEY = 'ENTER YOUR API';

(back to top)

Features and Functionalitye

Here are some key features of our platform:

  • User Registration and Profile Creation: Users can create accounts, set up profiles, and provide personal information and preferences.
  • Posting and Sharing: Users can create and share text, images, destinations, and other forms of content on their profiles or within the platform.
  • Likes, and Saves: Users can engage with content by liking, and saving posts.
  • News Feed: A feed that displays content from users providing an up-to-date view of their network's activities.
  • Posts Search: A search function to find posts by string criteria.
  • Protected Routes: Routes that can be accessed by authenticated users only.

(back to top)

Roadmap

  • Conceptualization and Planning

    • - Idea Validation
    • - Defining Niche
    • - Business Plan
  • Design and Prototyping

    • - Create logo
    • - Develop the user experience (UX) and user interface
  • Development

    • - Selecting the technology stack
    • - Implement the core features
    • - Performance Testing
  • Deployment

  • Post-Launch and Growth

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community truly fantastic! It's a place where we come together to learn, inspire, and create. We genuinely value any contributions you'd like to make.

If you have a cool idea to improve this project, don't hesitate to fork the repo and send us a pull request. Alternatively, you can easily open an issue with the "enhancement" tag.

Oh, and don't forget to give our project a star! Thanks a bunch for your support! 😊🌟

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Elvira Ivanova -linkedin-url: https://linkedin.com/in/elvira-ivanova - elvira.n.ivanova@gmail.com

Project Link: https://github.com/elviraIv/social-sphere-app

(back to top)

Acknowledgments

  • To be announced

(back to top)

Contributors Forks Stargazers Issues MIT License LinkedIn

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published