This project is a small Real Time Chat Application built using React as a Frontend to a server Backend found at this Github repository
It is a
Mobile Only Viewapplication built to demonstrate my knowledge and understanding of Web Sockets and the use of theSocket.ioandSocket.io ClientLibraries.
It allows any user to freely enter a chat name, select a chat group and start chatting freely with other users in the same chat group. The user can also view other users online and privately chat with them. The user also gets notified if they receive a message from a group or user they are not currently chatting with.
- Ability to create custom groups and add other users to it.
- Ability to search for users or groups available.
- An authentication system.
- Validation and display of error messages.
Unfortunately, the backend service project built to serve this frontend project was hosted on the Heroku free service plan which nolonger exists, therefore the Norp Chat App Server is currently unavailable and this frontend project is currently inoperable. But other hosting services are being looked into and one will be provided as soon as possible.
- ReactJS
- Node Package Manager(NPM)
- Socket.io Client
- React Bootstrap
- Norp Chat App Server
-
NPM(Node Package Manager) or Yarn
-
Node
-
Clone the repository to your local machine by running
git clone git@github.com:RNtaate/norp-chat-app.gitin your terminal -
On your local machine, navigate to the project folder using
cd norp-chat-appin your terminal -
Run
npm installoryarnto install all the necessary dependencies. -
Open the project in your favorite code editor such as Visual Studio Code
-
Locate the
HelperMethods.jsfile in thesrcfolder and change the value ofSOCKETLINKto"http://localhost:3001"(Make sure the port number is the same as the one on which the backend is running on on your local machine) -
Clone the Norp Chat App Server project to your local machine, locate the
app.jsfile and change the value oforiginin thecorsobject to'*'(don't forget to include the quotes) -
Run
npm run buildoryarn run build -
Install the dependencies in the
chat app server projectand start it up usingnpm startoryarn start -
Run
npm run startoryarn startto start the application on a local server
There are two ways of contributing to this project:
-
If you see something wrong or not working, please check the issue tracker section, if that problem you met is not in already opened issues then open the issue by clicking on
new issuebutton. -
If you have a solution to that, and you are willing to work on it, follow the below steps to contribute:
-
Fork this repository
-
Clone it on your local computer by running
git clone git@github.com:RNtaate/norp-chat-app.gitReplace RNtaate with the username you use on github -
Open the cloned repository which appears as a folder on your local computer with your favorite code editor
-
Create a separate branch off the master branch or main branch,
-
Write your codes which fix the issue you found
-
Commit and push the branch you created
-
Raise a pull request, comparing your new created branch with our default branch here
-
π€ Roy Ntaate
- Github: @RNtaate
- Twitter: @RNtaate
- Linkedin: roy-ntaate
Give a βοΈ if you like this project!
