Social Media Sample Project

INSTALL ALL REQUIRED MODULES BEFORE STARTING

    $ npm init
    $ npm install node
    $ npm install hbs
    $ npm install express
    $ npm install mysql2
    $ npm install sequelize

                    ---------OR---------

$ npm init
$ npm install node hbs express mysql2 sequelize       # install all in single step

Database Setup

$ mysql -u root

$ create database socialmediadb;

$ create user socialuser identified with mysql_native_password by 'socialpass';

$ grant all privileges on socialmediadb.* to socialuser;

$ flush privileges;

Project Structure

Backend (Server)

src
├───controllers      # functions to connect routes to db operations
├───db               # db connection and model definations
├───public           # html/js/css files for static part of site
└───routes           # express middlewares (route wise)
└───utils            # Username generator

Frontend (client side code)

src/public
├── app                         # our own frontend js code            
│   └── cbsocial-common.js
│   └── common.css
├── components                  # own html snippets   
│   └── navbar.html
│   └── footer.html
│   └── all-posts.html
├── css                         # css libraries we are using                  
│   └── bootstrap.css
│   └── login.css
├── index.html                  # first / home page
├── login.hbs [TBD]                   
└── js                          # js libraries we are using            
    └── bootstrap.js
    └── jquery-3.4.1.js
    └── popper.js

Business Structure

Users

1. create users this will create a new user with a random username

Posts

1. create post this will create a new post, required fields are

   • username (the author of this post)
   • title
   • body

2. show all posts list all existing posts, we should have following filtering support

   • filter by username
   • filter by query contained in title (search by title)

3. edit posts TBD

4. delete posts TBD

Comments

1. show all comments (of a user)

2. show all comments (under a post)

3. add a comment

Application

Search new user (GET request)

http://localhost:8383/api/users/:username OR http://localhost:8383/api/users/:id

Add new user (POST request)

http://localhost:8383/api/users

API Documentation

users

1. POST /users

Creates a new user with random username and an user id

2. GET /users/:userid

Get an user with a given user id

3. GET /users/:username

Get an user with a given username

Posts

1. GET /posts/

Get all posts by everyone

2. POST /posts

Create a new post.

Required fields in body-

userId
title
body