PERSONAL VUE.JS + SOCKET.IO CHAT PROJECT

This repo contains a personal javascript chat to learn and test something about Vue.js, Socket.io and Firebase (+ Bulma css framework)

---

What this project contains

                          

• Vue.js framework
• Bulma css framework
• Webpack
• ES6 supported
• Socket.io
• Firebase DB
• Login with GitHub (to retrieve user information and profile pict)

---

Browsers Support

9+	latest	latest	latest

---

Set up

Before cloning the repo be sure you have installed:

• NodeJs & npm (version >= 8.9.x)
• Yarn (version >= 1.3.x)
• Npm (version >= 5.5.x)

Then:

• Choose a folder project in your system and switch in cd [folder path]
• Clone the repo in your folder git clone https://github.com/ibbatta/vuejs-socketio.git

---

Installation

• Be sure to have a Firebase account
• Set up the Firebase auth with GitHub
• Create an .env file and import your Firebase credentials (like the example below)

NODE_ENV=development
APIKEY=FIREBASE_API_KEY
AUTHDOMAIN=FIREBASE_AUTH_DOMAIN
DATABASEURL=FIREBASE_DATABSE_URL
PROJECTID=FIREBASE_PROJECT_ID
STORAGEBUCKET=FIREBASE_STORAGE_BUCKET

• From the directory of the project run yarn

---

Usage

Once everything is installed, use Yarn from the terminal to start the build tasks.
The package.json expose these tasks:

• yarn start (start the project locally)

---

Todo

• Add extra login / auth
• Parse markdown for bold, italic and underline texts (???)
• Manage user connection notification
• Manage new chat notification
• Develop hashtag system (???)
• Develop search by user / hashtag

---

Contributing

• Fork it!
• Create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -am 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request

---

Credits

• Maurizio Battaghini (project lead and main developer)
• Davide Bontempelli (project support)

---

Troubleshootings

This is just a personal project, created for study and demostration purpose only. It may or may not be a good fit for your need(s).

---

GitHub @ibbatta  ·  Twitter @battago