🗨️ Console Chat 🗨️

Chat with friends and run cool and powerful commands

Chat application for chatting and running commands in a console like environment.

🔨 Built With 🔨

Visual Studio Code - The IDE used

⚒️ Made with ⚒️

💅 Styles provided by 💅

Bulma

👨‍💻 Author 👨‍💻

Petar Taushanov - ptaushanov

⚙️ Setting up the project ⚙️

Create a .env file in the root directory
Add the following in the file

# DB Secrets

DB_URI = 
DB_NAME = 

# Lobby Manager

USAGE_TERMS = 
LOBBY_TITLE = "ConsoleChat"
LOBBY_SUBTITLE = "Boost the ordinary chat with powerful, yet simple chat commands!"

After the = sign fill the missing information, where:
- DB_URI is the URI for the MongoDB database (can be local or hosted somewhere )
- DB_NAME is the name of the MongoDB database that you want to use
- USAGE_TERMS are the terms shown to the user on front page
- LOBBY_TITLE is the title shown to the user on front page
- LOBBY_SUBTITLE are the subtitles shown to the user on front page

⚙️ Running the project ⚙️

npm run start

npm run dev

The second option tracks changes in the project structure with Nodemon

Default port is set to 3000
It can be changed in the "server.js" script.

🪄 Using Commands 🪄

Commands can must start with the leading \ before the name of the command. Most used commands are:

\login -> login as a user with a username and password as arguments to the command
\register -> register a new user with a username and password as arguments to the command
\clear -> clear the messages "screen"
\help -> find helpful commands

License

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

ptaushanov/ConsoleChat