Skip to content

humanoidsbv/team-awesome-ruben

Repository files navigation

✍️Team Awesome!

A web app to log worked hours for you and your team!

Built with

  • GatsbyJS - Static site generator that is built on ReactJS
  • Redux - JS library for global state management
  • Travis CI - Host and build projects w/ Continuous Integration
  • ZEIT Now - Cloud platform service for deploying Serverless applications
  • Jest - JavaScript testing framework to ensure proper functioning components
  • StoryBook - Showcases components outside of the app for refinement and quick understanding

Getting started

  1. Prerequisites

    NodeJS - An open source, cross-platform runtime environment for developing server-side and networking applications.

  2. Setting up Team Awesome

    Clone this repository to a directory of your choosing:

    # Use terminal to install the application:
    git clone [email protected]:humanoidsbv/team-awesome-ruben.git
  3. Open the project folder and start it up!

    Change directory to the project directory and start it locally using:

    cd team-awesome-ruben
    npm run start

    Your site should now be running at http://localhost:8000!

Testing components

  1. npm test

    To test the application you can run the following command in terminal:

    #Run all tests once
    npm test
    
    or
    
    #Run all tests and rerun whenever a test file is saved
    npm test -- --watch

Run Storybook

  1. Start Storybook

    To view all generic components, run the following command in terminal:

    npm run storybook

    Storybook should now be running at http://localhost:6006!

Author

Acknowledgments