README.md

Grid

A Chat app built on top of Electron.

Introduction • Features • Requirements • Build • Run • Credits • Author • Contributing • License

Introduction

Grid is LAN messenger, which runs on server-client architecture over local network. I've build this for college usage (as Major project submission) ;)

Features

• Awsome UI
• Signup and Login
• Channels
• Emojis
• File Sharing
• Dark mode (coming soon)
• Voice & Video call (coming soon)

Requirements

To build this project you will need following

• NodeJS
• MongoDB

Build Process

To run this project, you have to build Frontend.

You will need Node Package Manager in order to build

Run following commands to build

$npm i
$npm build

Running Project

In order to run project, you have execute following command in Frontend and Backend folder seperate terminals.

$npm start

Credits

Project was possible with following Frameworks

• Electron
• Angular
• Express
• Mongoose
• ws-wrapper

Author

Contributing

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

License

MIT