Git Product home page Git Product logo

fake-twitter's Introduction

Fake Twitter

A very simple Twitter-like web application, assigned from react-assignments, you can check it online first https://hzraevets.github.io/fake-twitter/.

Tech-Stack

Not all the 3rd-party libraries / tools which are used in this project, are listed here. Like this project is initialized with create react app. So, feel free to explore them at your own.

Features

  • Register an account (store data in LocalStorage)
  • Login & logout
  • CRUD tweets
  • Load more tweets via scroll down
  • Switch theme
  • 1 column in iPhone screen size, 2 columns in iPad screen size

Setup

You should clone this project to your machine first:

git clone https://github.com/hzraevets/fake-twitter

enter into the project folder:

cd fake-twitter

and make sure you have Node.js installed first, then execute this command to install all dependencies:

npm install

Development

You may want to add some more features into this project, or modify existing code. So you should start up a dev server locally to check what's the app be like at real-time. Just execute this command:

npm start

Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

Add new commit

Once you finish your task and want to add a new commit, instead of using git commit, you should use the following command here:

npm run commit

Testing

npm test

Launches the test runner in the interactive watch mode. See the section about running tests for more information.

Storybook

npm run storybook

Open http://localhost:6006/?path=/story/views-login--preview to view all the stories.

Deployment

App

If you want to do all these work at your own:

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

Also, dockerfile is provided under ci, you can build it to an image first:

docker build -f ci/app.dockerfile -t fake-twitter-app .

and then run the container:

docker run -d --name app -p 3000:80 fake-twitter-app

Then you can visit http://localhost:3000 to check the app.

Storybook

Deploy storybook is similar to deploy app.

fake-twitter's People

Contributors

stevearzh avatar

Watchers

 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.