Skip to content

A social media platform that gives users the ability to express themselves in their own personal space.

License

Notifications You must be signed in to change notification settings

enzorod10/solteract

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


icon

Solteract: Social Media Platform

Social media platform that gives users the ability to express themselves in their own personal space.
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

A social media platform that gives users the ability to express themselves in their own personal space. Inspired by twitter. Users have their own timelines & feeds, are able to communicate with each other through transmissions (tweets) which can be text and/or media. Users can customize their profile name, username, header, & picture.

main

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Have node package manager (npm) installed

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/enzorod10/Solteract.git
  2. Install NPM packages
    npm install
  3. Start the application
    npm start

(back to top)

Usage

Users can transmit messages containing text and/or images.

transmission

Users can interact with a transmission by either replying, retransmitting, or favoriting a transmission. (Share feature not yet implemented)

interacttransmission

All user timelines are modified according to who they are following. In the image below, the user is following my personal account (@Enzo). So any transmissions I've made in that account will show up in this user's timeline, along with any retransmissions I may have done.

followfeature

Every user has their own personal profile page where they can see their own transmissions (can be filtered to show only the one's with images) and their favorites.

profile

All users have their own profile picture & header which can be modified at any time. Users can upload their own profile picture or use one of the default ones.

chooseavatar

They can also modify their profile header in the same way:

choosebackground

Every user is accessible! Start typing a letter and matching queries will show. For example, here I am typing the letter 'J' so any user who's name begins with the letter 'J' will show:

searchfeature

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • User authentication through Google or Email/Password
  • Responsiveness on any device
  • Ability to edit profiles
  • Search feature implemented
  • Ability to interact with transmissions
    • Ability to Reply
    • Ability to Retransmit
    • Ability to Favorite
    • Ability to Share

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 such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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. See LICENSE.txt for more information.

(back to top)

Contact

Enzo Rodriguez - Personal Website - [email protected]

Project Link: https://github.com/enzorod10/Solteract

(back to top)

Acknowledgments

(back to top)

About

A social media platform that gives users the ability to express themselves in their own personal space.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published