Skip to content

humanoidsbv/team-awesome-jarmo

Repository files navigation

Team Awesome 📅

Team Awesome is a "Software as a Service" (SaaS) solution that can be used by Humanoids employees for planning projects, tracking time and much more. On the timesheet page users can record their worked hours and get a clear overview of their work by filtering by client and sorting by date. On the Team members page users can provide information on the projects and clients they worked on. By clicking the green button on the right top-corner users can fill in the forms to provide all the information.

Installation 💿

To run the Team Awesome app Node and NPM are required.

# We suggest to use Homebrew as package manager for installing node. In order to install Homebrew we need to pull the latest installation script from the website.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Let's install Node.js using Homebrew:
Brew install node

# Now you can check your Node version by typing the following command:
node -v

Usage 👨🏻‍💻

# Run the application in development mode on your localhost
npm run dev

Technologies 💻

  • ReactJS
  • Next.JS
  • TypeScript
  • Styled-components
  • ESLint
  • Prettier
  • Vercel
  • Jest
  • Cypress
  • Storybook

Using Storybook 📕

Storybook is an open source tool for developing UI components and pages in isolation. It helps you document components for reuse and automatically visually test your components to prevent bugs.

# Install Storybook by running the following command in your terminal:
npx sb init

# Install required dependencies and setup the necessary scripts.

# Run Storybook by the following command:
npm run storybook

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Credits 🤝

I would like to give a special thanks to the Humanoids teachers and trainees for their guidance and explanations during the crash course, as well for their support during the Team Awesome project. Thanks to their patience and teachings I was able to develop my skills.