Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/radekxrandom/obiadekchat
[Unmaintained] Encrypted chat with many features
https://github.com/radekxrandom/obiadekchat
nodejs react socket-io
Last synced: 5 days ago
JSON representation
[Unmaintained] Encrypted chat with many features
- Host: GitHub
- URL: https://github.com/radekxrandom/obiadekchat
- Owner: radekxrandom
- License: mit
- Created: 2020-11-21T17:07:44.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-03T00:11:19.000Z (almost 3 years ago)
- Last Synced: 2023-11-15T19:27:07.533Z (about 1 year ago)
- Topics: nodejs, react, socket-io
- Language: JavaScript
- Homepage: https://obiadekchat.vercel.app/
- Size: 374 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#### [Unmaintained, som issues don't work. It's here for nostalgic reasons only]
Obiadekchat - https://obiadekchat.now.sh/
> Built with MERN stack (MongoDB, Express, React and Node) and socket.io.
> End to end RSA encrypted web chat single page application.
> User's have intuitive ways to customize their profiles and they can easily adjust security options in settings.
###
⚡️⚡️⚡️ [Obiadekchat](https://obiadekchat.now.sh/) ⚡️⚡️⚡️
## 📜 Table of contents
- [Main Features](#--main-features)
- [Technologies](#--technologies)
- [Future goals](#--future-goals)
- [Setup](#--setup)
## 🚩 Main Features
> This website enables users to message their friends without the need to provide any personal data.
> Messages are end-to-end RSA encrypted and by default are deleted 5 minutes after being viewed by the receiving user.
#### User profile
- **Registration and authentication**
- User account is generated when the new user visit the website for a first time.
- Because of this fact, customizing it is intuitive and easily accessible.
- **User settings and profile customization**
- Users can switch to dark theme 
- Changing username is as easy as hovering over it and typing a new one 
- Profile picture can be changed easily too 
- There are also settings that allow users to adjust security to their needs
#### Contacts network management
- **There are real time notifications about user's contacts**
- **Adding new contacts with a Search ID**
- Each user has a special Search ID which can be used by others to look up his profile. 
- To copy it users can click it or the icon next to it. Navigation with tab works too.
- After finding someone's profile a friend request can be send.
- This request can be either accepted or declined.
- **Adding new contacts with a URL**
- Users can also add contacts by sharing a specially generated URL with them.
- Each URL can be used only once.
- It can be shared with friends who already use the website or with completely new users.
- **Removing contacts**
- Deleting contacts requires only two click of the mouse.
#### Responsive design
- **Especially for a chat application it is very important to look (and work) good on mobile devices. Please see for yourself using developer's tools in your browser**
## 💹 Technologies
> Project is created with:
#### Server
- Express
- Mongoose
- JWT Tokens for authentication
- bcryptjs for one way password hashing
- socket.io for real-time, bidirectional, event based communication between client and server. Oh and also for having a level of abstraction over managing WebSockets, long polling, etc.
- mocha
#### Client
- React JS
- Redux (although I am moving away from it)
- Redux Thunk
- Axios
- rsuite (although I am moving away from it because of bad a11y support)
- Hybrid Crypto JS
- WDYR for help with optimization in development mode
## 💡 Future goals
- Full a11y compliance. As of now only the Starting page is easily navigated with keyboard and has 100% correct aria labels.
- Polish localization.
- Being able to use one account on different devices.
- Better test coverage.
- Cleaner and faster code.
- Many, many other things.
## 💻 Setup
To run this project, install it locally using npm:
```
$ git clone https://github.com/radekxrandom/obiadekchat.git
```
Backend
```
$ cd obiadekchat/back
$ yarn install (install backend dependencies)
$ yarn run devstart (use nodemon to auto reload on changes)
```
Frontend
```
$ cd obiadekchat/front
$ yarn install (install frontend dependencies)
$ yarn start
```
Remember to create .env file and populate it with constants needed for the application to work.