Team Awesome is a demo cross-platform app to track and manage work hours of team members, current projects, clients and documents.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
To use this app you will need Node.js and Next.js.
To deploy this project in a live environment, you can use Now.
First, clone the source locally:
$ git clone https://github.com/naomiaz/team-awesome.git
Install project dependencies:
$ npm install
Run the app:
$ npm run dev
The app runs on localhost:3000
. To use another port, you can run npm run dev -- -p <your port here>
.
The unit and snapshot tests are written with Jest and Enzyme. You can find the written tests in the __tests__
folder inside the ./components
and ./services
folders. To run the tests:
$ npm run test
All generic components are documented in Storybook, a development environment for UI components.
To run Storybook:
$ npm run storybook
- React - JavaScript library
- Redux - Application state management
- Next.js - Dependency management
- Now - Serverless deployment
- Jest - Test runner and unit testing utility
- Enzyme - Snapshot testing utility
- Storybook - UI development environment
Naomi Zuiverloon - naomiaz
This project is licensed under the ISC License.
- Sean Tijmons - reviewing partner
- Boris Arkenaar - coding teacher
- Robbin Habermehl - coding teacher
- Aron Martin - coding teacher