ajibs / mini-twitter

Connect with other people. (Mini Twitter Clone)

Home Page:https://mini-twitterify.herokuapp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Twitterify

Connect with other people.

Twitterify is a Chaser Project.

Feature List

  • User can signup and login
  • Authenticated User can post a tweet (max of 200 characters)
  • Autheticated User can reply to tweets
  • On replying someone, they would be notified via email
  • User is able to view all tweets and replies
  • Authenticated User can like tweets

Getting Started

Twitterify is hosted on Heroku and can be accessed here:

You can visit the application by clicking the above link and play around with the features.

Prerequisites

These are what you need installed on your computer to use the application:

  • Web Browser (Chrome, or Mozilla, or Safari, or Opera, or Microsoft Edge )

For Developers:

Setup

Local Copy

To create a local copy, run the following in your terminal:

git clone https://github.com/ajibs/mini-twitter.git

Then change into the local directory, run the following in your terminal:

cd mini-twitter

Install Node.js and Yarn

If you don't have Node.js installed, please go ahead and grab it here. This project uses ES6+ features and requires Node version 8.9.4

Yarn is a package manager for Node.js and can be installed from here.

To confirm that you have Node.js installed, run the following in your terminal:

node -v

You should get something like v8.9.4.

To confirm that you have Yarn installed, run the following in your terminal:

yarn -v

You should get something like 1.3.2.

Setup Database and .env file

You should also create a .env file using .env.sample as a prototype. Run the following in your terminal:

cp .env.sample .env

You can setup a database on mlab and replace the DATABASE placeholder in .env

Signup on Mailtrap and replace the placeholders of MAIL_USER and MAIL_PASS in .env to ensure the email functionality works.

Install Node.js Modules

To install all dependencies, run the following in your terminal:

yarn

Development

To kickstart the application, run the following in your terminal:

yarn start

If you'd like to continue full-stack development on this project, run the following in your terminal:

yarn dev

Open up your web browser and visit the following url to seed the database:

http://localhost:4400/seed

Visit the following to access the home page

http://localhost:4400/

Built With

Author

About

Connect with other people. (Mini Twitter Clone)

https://mini-twitterify.herokuapp.com/

License:MIT License


Languages

Language:JavaScript 56.0%Language:CSS 22.1%Language:HTML 21.9%