Code Monkey home page Code Monkey logo

twitter-clone's Introduction

Twitter Clone

Installation Instructions (Linux)

Pre-requisites:

  • Node.js
  • npm
  • MongoDB

After downloading files carry out the following instructions once inside the project directory.

Install Packages

Install all packages for client side:

> cd client && npm install

Install all packages for server side:

> cd server && npm install

Connect to Database

After these two steps there are two options regarding the database.

Either replace the MongoDB connection string on line 11 in /server/server.js with a local connection string or remote connection string.

Local connection string ( port is 27017 by default ):

mongodb://localhost:<port>/twitterDB

This option requires an extra step when using the project as you will have to run MongoDB, it's simple just enter the following command in your terminal:

> mongod

Remote connection string:

Read this for more information.

Start Client & Server

Once all npm packages are installed run the following command in both /client & /server:

> npm start

Description

This is the first iteration of this project, if you have any suggestions please leave it in the issues section.

This application is a clone of Twitter. Containing an almost identical UI, with a very similar user experience. For this project, I have written both the backend API and the front end.

At this current moment in time, users are able to register, sign in and make a post. Additionally, users can view their own and other user's profiles, to look at their tweets.

Users are only able to make a tweet if they are logged in, and only individual profiles may be viewed if not logged in.

Future Plans

This is a project with a lot of potential to showcase a range of skills, which I will slowly add to as I learn new technologies that will take this project to the next level.

As of now, my plans include:

  • Ability to delete tweets
  • Improve the User data model, allowing for a biography and profile picture; also including email in the sign up process that must be verified before utilising protected routes

Known Bugs

Technologies Used

  • HTML
  • CSS
  • React ( with react-router-dom )
  • Node.js ( with Express )
  • MongoDB ( with Mongoose )
  • JavaScript ( with axios and )

twitter-clone's People

Contributors

aadam-ali avatar

Watchers

James Cloos avatar  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.