Skip to content
/ lookatme Public

Simple website "game" that tracks users watching in real time and count of clicks.

License

Notifications You must be signed in to change notification settings

nheek/lookatme

Repository files navigation

LookAtMe

LookAtMe front page

LookAtMe is my first attempt at making a Socket.IO web application. It has given me a lot of new ways to think about how to make a code scalable. The real-time feature of LookAtMe will also build upon my future projects such as real-time messaging applications and so.

Table of Contents

Getting Started

Just follow the steps below and you should be good to go.

Prerequisites

  • Node.js
  • npm (usually comes with Node.js installation)

Installation

  1. Clone the repository:

    git clone https://github.com/nheek/lookatme.git your-project
  2. Change into the project directory:

    cd your-project

Development

Run the development server using nodemon:

npm run dev

Usage

Click the button and see the total clicked count update in almost real-time. It also logs the amount of people currently watching the page and the overall views. A simple yet intuitive way to learn about Socket.IO.

Deployment

Deploy using your preferred deployment method.

Built With

ToDo

  • SQL file in source code
  • Make it really real-time, right now there's a one second delay to prevent database overloading
  • Statistics page where users can see historical data like daily clicks/views

Contributing

If you'd like to contribute, please fork the repository and create a pull request. Issues and feature requests are welcome!

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Acknowledgments

Special thanks to everyone who had indirect contributions to this project through the inclusion of their works which are specially mentioned in the source code.