AnthonyBronca / Twiller

A Twitter Clone

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Twiller

Twiller is a loose clone of a dimmed themed version of Twitter. Twitter allows users to share and post their thoughts, pictures, and interact with others via follows, likes, comments, and replies.

Check out Twiller

Index

MVP Feature List | Database Scheme | User Stories | Routes

Sign Up

Sign up feature

Tweet Splash Page

Tweet Splash Page

Technologies Used

Getting started

  1. Clone this repository:

    git clone https://github.com/AnthonyBronca/Twiller.git
  2. Install dependencies with the following:

    npm install
  3. Create a .env file using the .envexample provided

  4. Setup your PostgreSQL user, password and database and make sure it matches your .env file

  5. Create Database using the following commands:

npx dotenv sequelize db:create

npm run db:reset

db:reset will create, migrate, and seed your database using scripts.

  1. Now you can use the Demo User or Create an account

Features

Users

  • Guest users can create a new account

Posts

  • Users can create a post on Twiller with Words or Pictures
  • Users can read/view other posts
  • Users can update their posts
  • Users can delete their posts

Comment

  • Users can create comments on posts
  • users can read/view all of the comments on a post
  • Users can delete their comments on a posts

Future Features

Following

Logged-in Users can

  • Follow other users
  • Be followed by other users

Likes

Logged-in Users can

  • Like tweets
  • Like comments

Profiles

Logged-in Users can

  • view and edit their profile
  • delete their profile
  • view other peoples' profiles

Retweets

Logged-in Users can

  • Report other peoples' tweets as a quoted tweet to be shared to their followers

Search

Logged-in Users can

  • Search for other users and choosed to follow/unfollow

About

A Twitter Clone


Languages

Language:JavaScript 87.3%Language:CSS 12.0%Language:HTML 0.6%Language:Shell 0.1%