Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
LuizPelegrini committed May 1, 2021
1 parent 52661f4 commit 8b5cdbb
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<h1 align="center">Chatty</h1>

<p align="center">
<img alt="License" src="https://img.shields.io/static/v1?label=license&message=MIT&color=8257E5&labelColor=000000">
</p>

<br>

## ✨ Technologies

This project was developed using the following technologies during the 5th NextLevelWeek.

- [Node.js](https://nodejs.org/en/)
- [Typescript](https://www.typescriptlang.org/)
- [Express](https://expressjs.com/pt-br/)
- [Socket.io](https://socket.io/)

## 💻 Project

Chatty is realtime application that allows a user to communicate with an attendant (admin) using the Websocket Protocol.

## 🚀 How to run:

- Clone this repository
- If you don't have the `database.sqlite` file inside the `src/database` folder, create one and run `yarn typeorm migration:run` to create the database tables.
- Run `yarn dev` to start the application.

All set! The application will be available at `http://localhost:3333`

- To open client view, use `http://localhost:3333/pages/client`
- To open administrator view, use `http://localhost:3333/pages/admin`

0 comments on commit 8b5cdbb

Please sign in to comment.