Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 2.11 KB

README.md

File metadata and controls

54 lines (42 loc) · 2.11 KB

Team Awesome

Team Awesome is a Software as a Service (SaaS) solution that can be used by organizations and their employees for tracking time when working on projects.

Features

  • ⏱ Track time when working on projects
  • 🚁 See an overview of all your team members and which client they're working for
  • 🎛 Sort your time entries by client or based on date
  • 👫 Line-up your team members based on first name

Prerequisites

Using the latest stable Node version (LTS) & the latest release of NPM is recommended. Check your Node version with node -v in your terminal.

How to run

  1. Clone the repo
git clone [this/repo]
  1. Install the dependencies needed to run the app
npm i
  1. Run a local build
npm build

Run tests

This app uses Jest, React testing library and Cypress for unit testing, snapshots and end-to-end testing. To run these you can use npm test.

Run Storybook

For documenting, testing and creating reusable components this app uses Storybook. To run it you first need to have a local build of Team Awesome running on your machine. Then you can use:

npm run storybook

This will start Storybook locally and output the address. Depending on your system configuration, it will automatically open the address in a new browser tab, and you'll be greeted by a welcome screen.

Build upon

  • React & NextJS to make the app interactive ⚡️
  • Typescript to speed the development process and spot bugs sooner 🪲
  • Styled components to make it pretty ✨
  • Vercel to deploy the app 🚀
  • Storybook for documenting, testing and creating reusable components 📚

Contributions

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

Credits

A special thanks to all the excellent teachers and trainees at Humanoids for their guidance, patience and help! 💙 To get to work on this project every day among these lovely people was amazing.

License

MIT