Skip to content

bethropolis/suplike-social-website

Repository files navigation

logo

hello welcome to suplike

suplike github watch CodeFactor code

suplike social is a feature rich fully open source social network.

it's made using PHP/HTML/JS/CSS

it's easy to install and setup;

check out demo

Table of Contents

getting started

Installation

Requirements

  • PHP
  • Apache server
  • MySQL Database
  • phpMyAdmin (optional)

All of these requirements can be completed at once by simply installing a server stack like Wamp or Xampp etc.

Installation Steps

  1. Download the latest release file.
File Description Size
v1.5.1 zip file Latest release zip file 1.4 MB
v1.5.1 tar file Latest release tar.gz file 3.0 MB
v1.5.1 installer-script.php installer script 2 kB

unzip the file and extract all the files into your htdocs or www directory depending on what you are using. (installer script does this automatically)

I recommend renaming the extracted folder to suplike (the url will be shorter).

  1. if you choose to use the installer script then first you need to download the script into your server folder then run the following command.
  php installer-script.php

  1. you can clone the repository to your htdocs or www folder.
  git clone https://github.com/bethropolis/suplike-social-website.git suplike

now you are ready to setup.

setup and configure database

using the GUI

the GUI is a nicer interface which will automatically setup the database and create admin account for you easily.

GUI
The GUI should open by default on the first time you run the app. If it doesn't then on the browser navigate to {HOST_URL}/suplike/inc/setup/.

on the GUI you insert the credentials to your database and admin account after which you will automatically be logged in as admin.

please note in the url, replace suplike with what you named the folder or the folders name (also remove if the app is on the root directory).

incase GUI doesn't work

  1. Edit the inc/setup/setup.suplike.json and inc/setup/env.php file and set the value of "setup" to false then reopen the GUI in your browser again.

  2. Do it Manually, create a database suplike and Import the suplike.sql file in the sql folder into phpMyAdmin. There is no need for any change in the .sql file. Next, change the following part of code below in the inc/setup/env.php to the respective database credentials.

 if (!defined('DB_DATABASE'))        define('DB_DATABASE', 'suplike');
 if (!defined('DB_HOST'))            define('DB_HOST','localhost');
 if (!defined('DB_USERNAME'))        define('DB_USERNAME', 'root');
 if (!defined('DB_PASSWORD'))        define('DB_PASSWORD', '');
 if (!defined('DB_PORT'))            define('DB_PORT',3306);

you'll also manually have to change you account to admin account in the database.

Components

Languages

PHP 8.0+
SQL 14.0+
JavaScript ES 6
HTML5
CSS3

Development Environment

apache 2.4+
MYSQL 9.0+

DBMS (optional)

phpMyAdmin 5.0+

versions

check HISTORY.md or releases

more improvements will continue to be done to this project please stay and watch 👀.

features

Mobile UI

Alt text

The app is mobile friendly and responsive. the app's themes can easily be changed

live messaging/chat system (whole new look)

read more

Alt text

in previous version, one of the issues was that the messaging page was just a page. Live messaging was not well supported and you could not choose who to chat with until you clicked message on their profile page. But in the new version, the entire code was re writen and the whole of that is gone, you can chat with the people you follow and it is more mobile responsive than previous and the only client page that uses Vuejs.

home page

read more

Alt text the home page is the main page where you can see post from some of the people you follow and the first page you will land on after authentication.

profile page

read more

Alt text access to your profile page and other users profile page.

login/signup system

read more

Alt text you will have login or sign up to full use the app features.

search page

read more

Alt text

the search page is where you can search for users for now.

following page

read more

Alt text

The following page is where you can vue the users you follow (for now);

image and text post

you can currently only post either an image or text likely more in new versions to come.

like & follow system

you can like a post or unlike it, comment and share are still not functional but the like system is fully working together with the follow system and bothare perfect and most secure.

Developer Page

The Developer Page empowers you to create API keys and Bots, which can be utilized on the /api/v1 endpoint. These tools allow you to extend the functionality, incorporate additional features, and enhance the user experience.

Alt text

other user pages

other pages include comments page, post page, settings page, topics page, stories page and notifications page.

Plugins (beta feature)

with plugins you can extend the functionality of the app and add more features to the app.

the plugin ui is on the admin dashboard.

Admin dashboard

read more

Alt text The Admin Dashboard allows you to see analytics and perform moderation functions

you can do the following on the dashboard

  • see post,visits,activities analytics
  • moderate
  • install/uninstall plugins
  • see new users and old users
  • users online
  • edit default app theme, name and configurations
  • view the app logs
  • email configuration
  • api configurations
  • Plugin support.

inspiration

my biggest inspiration to make this app was was the KLIK social website on github, thank you msaad1999 for making an amazing project.

behind it all

Hi, I am bethuel. This is a favourite project of mine that I really enjoy making, I made it 3 years ago as a way to help me learn programming. hope you like it.

more versions are to come check HISTORY.md for more.
if you like to contribute please don't mind sending a pull request I will check it out, all ideas aloud.

bethropolis

you can show support to this project by staring this repo, it really means alot to me.

License

it is licensed under my favourate License MIT license (do what you want :).