TeamStar by BraveSquirrels!

Table of Contents

• General Info
• Technologies
• Requirements
• Setup
• Resources
• Documentation

General Info

---

Winning hackathon? For sure we are! But first things first, We are glad to announce that since today, you can use our new Application "Team Star", to make your every day work-life even more organised! We took care both of employees, and their supervisors! Don;t worry, you won't be working too much, and your employees will be relaxed for sure!!

Be our guest, fasten your seatbelts, and see what we've got for you!

Check it out on youtube!

If you don't want to run our project locally, you do not have to read anything more, be our guest, and visit our site! We although suggest you to read the documentation first, so you can get as much as possible!

Technologies

---

Project is created with:

• TypeScript
• Node.js
• Express.js
• React
• Redux
• Redux-Thunk
• MongoDB
• Socket.io

Requirements

---

To be able to run our project locally, you need to have installed yarn package manager If you do not know if you have it installed on your computer and you still want to run our project follow these steps:

Windows command prompt/Linux bash

Run npm -v

• If you received a number like 'x.x.x' you already have installed npm package manager *on your computer and you can follow the next part, which is installing yarn
• Otherwise, you will have to install it, the best way to do it is installing it globaly by running the command npm install npm@latest -g
• After that you can run again the command from the first line just to confirm that you have succesfully installed required package manager

Install yarn

• To install yarn package manager (faster vesrion of npm) run the commnad npm install --global yarn
• confirm yarn install by tpying command yarn --version

Setup

---

DataBase

• To run the project locally you will have to create your own MongoDB Atlas account, and have your own cluster/db created here

To run the project locally follow these steps:

• Clone this repository
• Open repository in your code editor
• Run command yarn dev:i
• Create .env file within the server catalog, this file should contain important information which lack of will cause fatal errors.
  
  this is the data that you should add into .env file:
  
  MONGO_USER=<you user name>
  MONGO_PASSWORD=<your user password>
  MONGO_DB_NAME=<your db name>
  PORT=5000 < Leave it like that!
  ADDRESS=localhost < Leave it like that!
  JWT_PRIVATE_KEY=<some random password>
  EMAIL=<your email>
  PASSWORD=<your email's password>
  
  (PS your email must be an yahoo email, it's complicated, trust me... If you do not however, don't mind visiting this site )
  
  
• Run command yarn dev
• Enter the local host that was created which should be at http://localhost:3000/
• You can now use our fully functional application!*

Documentation

Registration

• In order to use our application, you need to create an account, don't worry, we are not collecting any personal data :)

Afther that, you can create your own team, or join your friends!

Core benefits of our app are:

• Live chat with coworkers in team!
• Live monitoring of work time!
• Live meetings callendar! Break time!
• 

• Workflow :)