Chatot

📌 Sumary

• Introduction
• Technologies
• How to Run
• Bugs and Issues
• Contributing
• License

📎 Introduction

Chatot is a Web App made with Node.JS. It pretends to be a simple chat application, focused on the technologies around problems related to those type of system. So for example, it not have authentication and authorization implementations, because this is not the focus of the project. It uses concepts like Clean Architecture to build-up the structural parts, Docker for easy infrastructure management and Tests to code coverage.

💻 Technologies

• NodeJS
• Typescript
• Express
• Jest
• Supertest
• Socket.io
• Docker
• React
• Chackra UI
• Recoil

🚀 How to Run

Backend

# Build
$ cd server

$ docker-compose build

# Prod mode
$ docker-compose -f docker-compose.yml up

# Dev mode
$ docker-compose -f docker-compose.yml -f docker-compose.dev.yml up

# Test
$ docker-compose -f docker-compose.yml -f docker-compose.test.yml run --rm app

# Build
$ npm build

Frontend

$ cd web

# Use NPM or Yarn
$ yarn install

# Dev mode
$ yarn start

After start, the site will be acessed at http://localhost:8080

🐛 Bugs and Issues

Feel free to open new issues and colaborate with others issues in Chatot Issues

👨‍🔧 Contributing

This project is completely open source, so if you want, consider forking it and making PRs with the changes you think its helpful to the project growns.

📚 License

Released in 2020 under MIT License

Made with ❤️ by Luan Souza.