TeamHub Project

Adobe XD Wireframes

Table of Contents

• TeamHub Project
  • Table of Contents
  • Getting Started
    • Installation
    • Setting up your Development Environment
  • Troubleshooting
  • Contributing
  • Documentation

Getting Started

Installation

Clone from GitHub with: git clone https://www.github.com/waterloop/teamhub.git

Navigate to /backend/data/config.template.json.

Make a copy and rename it to config.json.

Follow the instructions listed under Setting Up Development Environment

Setting up your Development Environment

Here are the steps to run locally:

1. Install Docker and Docker Compose
2. Copy the contents of /backend/data/config.template.json into /backend/data/config.json
3. Install MongoDB and MongoDB Compass
4. Go to the root directory and run npm run build:docker
5. To start the server, simply go to the root directory and run docker-compose up -d teamhub
6. If this is your first time setting up, run npm ci. Wait for the installation to finish.
7. Wait a second then try opening localhost:3000 in your browser
8. If this is your first time setting up, you may need to populate the database with mock data. Do this by running mongorestore -d teamhub docker/mongodb/docker-entrypoint-initdb.d/dump from the teamhub directory

After finishing a work session, you can stop all containers by running docker-compose stop

Additional Notes:

• To run a command in the docker container, first run docker exec -it teamhub_nodejs /bin/sh, which will open up a shell into the container and then you can run whichever commands you wish. To exit out of the container, press Ctrl + C.

Running Unit Tests

To run tests locally:

1. Run docker-compose up -d test
2. Run docker exec -it teamhub_testing /bin/sh to go into the docker container and access the docker shell
3. Run npm run test to execute all test cases.

Troubleshooting

• To use the MongoDB Compass desktop app, use localhost as the hostname and the default port 27017.

• If the DB did not load successfully from the dump and is empty, run docker-compose rm and then restart the server with docker-compose up.

If Installing Docker Doesn't Work

1. Install Node.js and MongoDB locally
2. Run the script under /docker/mongodb/docker-entrypoint-initdb.d/import.sh if you are on Linux system. If you are on Windows or Mac, you may have to modify the command the script slightly.
3. Run npm install in the root directory of this repo to install all othe dependencies
4. Run npm run dev to start the dev environment

Notes about Contributing

Please create a new Git branch and work on your issue/feature on that branch. Ask the team lead which branch you should branch out from.

Use the following branch naming convention: {first_name}.{last_name}/{descriptive_name_for_your_task}

Documentation

https://docs.google.com/document/d/10TdYNHSy5nAID4gu48gxqB8-lJWQHVfyYjl5rlyP6HU/edit