An open API service indexing awesome lists of open source software.

https://github.com/humanoidsbv/team-awesome-ruben


https://github.com/humanoidsbv/team-awesome-ruben

List: team-awesome-ruben

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

          

## ✍️Team Awesome!

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

### Built with

- [GatsbyJS](https://github.com/gatsbyjs/gatsby) - Static site generator that is built on ReactJS
- [Redux](https://redux.js.org/) - JS library for global state management
- [Travis CI](https://travis-ci.org/) - Host and build projects w/ Continuous Integration
- [ZEIT Now](https://zeit.co/now) - Cloud platform service for deploying Serverless applications
- [Jest](https://github.com/facebook/jest) - JavaScript testing framework to ensure proper functioning components
- [StoryBook](https://github.com/storybooks/storybook) - Showcases components outside of the app for refinement and quick understanding

### Getting started

1. **Prerequisites**

[NodeJS](https://nodejs.org/en/) - 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:

```sh
# Use terminal to install the application:
git clone git@github.com: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:

```sh
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:

```sh
#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:

```sh
npm run storybook
```

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

### Author

- [Ruben Werdmuller](https://github.com/rubenwerdmuller)

### Acknowledgments

- [Robbin Habermehl](https://github.com/RobbinHabermehl) - Tutor & codewiz
- [Aron Martin](http://www.aronmartin.com) - CSS & code assistance
- [Dylan Jongbloed](https://github.com/dylanjongbloed) - Coding partner