Coder Social home page Coder Social logo

developers_club's Introduction


React Social Media - RadSocial

A facebook clone created using the MERN stack.

· Report Bug

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License

About The Project

[![Product Name Screen Shot][product-screenshot]]

I wanted to use the react fundamentals that I have learned from my react pokedex project (hosted on my github), as well as the fullstack fundamentals that I learned from creating my campgrounds viewing web application (hosted on github as well), to create a fullstack social media platform site. I will add more features as I learn more about web development, and hopefully others can learn from this project as well.

(back to top)

Built With

  • React
  • Express.js
  • MongoDB
  • NodeJS

(back to top)

Getting Started

  1. First perform git clone <githuburl> to get all source files locally
  2. Install nodemodules npm install in root folder
  3. Create a local build of client by executing npm run local in root folder
  4. Start the local server by executing npm start in root folder
  5. include .env file in root folder with following credentials

CLOUDINARY_NAME='enter cloudinary api name' CLOUDINARY_API_KEY='enter cloudinary api key' CLOUDINARY_API_SECRET='enter cloudinary api secret' SESSION_SECRET='write a secret, it can be a random string eg: helloworld' MONGO_URL='enter mongoatlas url, starts with mongodb://'

Usage

  • You are free to use a test account username:cattleherd password:password for demo purposes.
  • Login using the demo account credentials

To create a post

  1. Click the green album icon which will prompt you to upload an image
  2. You may also write a description
  3. Press the share button to create a post!

[![Product Name Screen Shot][product-screenshot2]]

  • The items highlighted are the different interactivity points of the homepage
  • The top left allows you to search the profile of any registered user
  • The messenger icon below it will give you access to live chat features
  • The profile page button will redirect to your profile page

Adding a friend

  • In order to follow someone you must search their profile page using the search icon on the top left, then press the follow button
  • The user will only show up on the friends list if they are following you as well (both parties must follow eachother)
  • Only friends will show up in Messenger app

[![Product Name Screen Shot][product-screenshot3]]

Chatting in real-time using messenger app

  • Users can select a conversation on the left to view conversations
  • the notification circle will turn from gray to green when the friend is online
  • messages are sent and received in real-time
  • logging out is easy, just click log-out on the top right

[![Product Name Screen Shot][product-screenshot4]]

(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)

developers_club's People

Contributors

sagarjaiswal07 avatar genius-ayush avatar ayushasati avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.