Skip to content

kiarashatri/telegraph_client

Repository files navigation

Telegeraph Messenger - Client Side

This Project is a Light-weight But Powerfull Messenger WebApp that work with it's own Back-end.
You Can find it's Open Source Back-end On Following Repository : Telegraph-Server.
caution : back-end of this project isn't completed yet , its will be complete and publish very soon .

Running Live Server Roadmap :

  • Make sure you have installed Node.js

    Node -v
  • Install dependencies :

    npm install
  • instantiate .env file :

    cp .env.example .env

    you can read more about Environment Variables requirements in document

    • To run this project, at least this environment variables are require:
      SERVER_URL
  • Run Live Server :

    npm run start

After following this step's , Your localhost live server Url shown in your Terminal/Command-line . Make sure you do not close Terminal during using Live server

Build Static files for Deploy Project Roadmap :

  • Make sure you have installed Node.js

    Node -v
  • Install dependencies :

    npm install
  • instantiate .env file :

    cp .env.example .env

    you can read more about Environment Variables requirements in document

    • To run this project, at least this environment variables are require:
      SERVER_URL
  • Build Project :

    npm run build

After following this step's , A New folder created called (./dist) and all your Ready2deploy files inserted there so you can Upload that folder in the real Hosting or server to serve on Web .

Docker

As soon as Project complete, Docker Image Will be Avaliable.

Demo

As soon as Project complete, Demo will be upload on server.

Features

  • Messenger
  • Story
  • Growl (Tweet)
  • Dark/light Theme
  • Profile page
  • Add friends

🛠 Used echnologies :

  • Interface : React, Html, Scss, TailwindCss, Material UI

  • Server Requests : WebSocket.io, Axios

  • State Management : ReduxToolKit

End Point's :

  • /

    • /login
      To login to an existing user

    • /register
      To register a new User

    • /email-confirmation
      To register a new User

    • /{:user}
      to access main user page

      • /{:to}
        Messenge to an other user

Documentation

Documentation

Contributing

Pull requests are welcome!
For cleaning changes , please open an issue first to discuss what you would like to change.

Authors

About

Client-Side Web App of Telegeraph Messenger

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published