README.md

Chat support page

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

👩🏻‍💻 About the project

• Real time chat web application in node.js using websockets

🚀 Technologies

Technologies that I used to develop this chat

• NodeJS
• TypeScript
• Socket io
• Express js

💻 Getting started

Clone the project and access the folder

$ git clone https://github.com/cahribeiro/chat-node.git && cd chat-node

Follow the steps below

# Install the dependencies
$ yarn
$ typeorm
$ express
$ sqlite3
$ socket.io

# Start the client
$ yarn start

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork cahribeiro/chat-node

Follow the steps below

# Clone your fork
$ git clone cahribeiro/chat-node && cd chat-node

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with 💜  by Carolina Ribeiro 👋  See my linkedin