Skip to content

Commit

Permalink
Merge pull request #32 from webgem-xyz/AddMedia
Browse files Browse the repository at this point in the history
✨ InputGroup Component now accepts the props fullWidth & placeholder.
✨ AddMedia now accepts prop uid.
✨ AddMedia component.
✨ Home component to README.
✨ Updated README to reflect changes made.

🐛 Placeholder of input field date from "loading coordinates.." to "YYYY-MM-DD".
📝 Moved SyncState of measurements to components/home/index.js ( #31 ).
📝 Moved AddMeasurements function to components/home/index.js ( #31 ).
📝 Changed router to send all paths except account to /home and setup a router in /home to send to the right component.

📝 Cleaned up code of the Overview Component.
📝 Fixed issue #29 in src/style/index.scss
📝 Fixed issue's #26 #24 & #23 in src/components/header/style.scss

✨ Added Login component.
✨ Added Account component.
📝 The InputGroup Component now accepts autoComplete as a prop.

🐛 Added missing newlines in Login & Account.
📝 Added browser support to README

🐛 Fixed spelling mistake in README on line 7 (collaboration)
🐛 Fixed spelling mistake in src/components/inputGroup/index.js (autoComplete: PropTypes.string - line 44)
  • Loading branch information
Yannick committed Jan 18, 2018
2 parents fa583ea + acbf28d commit 5673fe9
Show file tree
Hide file tree
Showing 26 changed files with 1,098 additions and 156 deletions.
58 changes: 58 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Changelog
All notable changes to this project will be documented in this file.

## [Unreleased]

## [0.0.3] - 2018-01-18
### Fixed
- Spelling mistake in README (line 7)
- Spelling mistake in InputGroup Component (Proptypes.sring > PropTypes.string - line 44)

## [0.0.3] - 2018-01-17
### Added
- Login Component.
- Account Component.
- Added browser support to README

### Changed
- The InputGroup Component now accepts autocomplete as a prop.

### Fixed
- Missing trailing newline at end of login/style.scss & account/style.scss

## [0.0.2] - 2018-01-17
### Added
- RemoveButton Component.
- ProgressBar Component.
- Updated readme to reflect the new RemoveButton and ProgressBar Component.

### Changed
- Moved remove input and ProgressBar out of Add & AddMedia into there own components.
- Replaced code of date of measurements with InputGroup Component.

### Fixed
- Duplicate code in AddMedia.
- Reduced lines of code in the AddMedia Component.

### Removed
- Removed UID prop from Add component as it doesn't use / need it.
- Removed trailing unused code.

## [0.0.1] - 2018-01-17
### Added
- InputGroup Component now accepts the props fullWidth & placeholder.
- AddMedia now accepts prop uid.
- AddMedia component.
- Home component to README.
- Updated README to reflect changes made.

### Changed
- Placeholder of input field date from "loading coordinates.." to "YYYY-MM-DD".
- Moved SyncState of measurements to components/home/index.js (#31).
- Moved AddMeasurements function to components/home/index.js (#31).
- Changed router to send all paths except account to /home and setup a router in /home to send to the right component.

### Fixed
- Cleaned up code of the Overview Component.
- Fixed issue #29 in src/style/index.scss
- Fixed issue's #26 #24 & #23 in src/components/header/style.scss
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@
"preact-compat": "^3.17.0",
"preact-router": "^2.6.0",
"re-base": "^3.2.1",
"react-router": "^4.2.0"
"react-firebase-file-uploader": "^2.4.1",
"react-router": "^4.2.0",
"recharts": "^1.0.0-beta.9"
}
}
115 changes: 109 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
# UVA app
![Build](https://travis-ci.org/webgem-xyz/UVA-React.svg?branch=master)
[![GitHub version](https://badge.fury.io/gh/webgem-xyz%2FUVA-React.svg)](https://badge.fury.io/gh/webgem-xyz%2FUVA-React)
![Coverage](https://img.shields.io/badge/coverage-99%25-brightgreen.svg)
[![Test Coverage](https://api.codeclimate.com/v1/badges/1d0d80ff5c2acd17b3d1/test_coverage)](https://codeclimate.com/github/webgem-xyz/UVA-React/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/1d0d80ff5c2acd17b3d1/maintainability)](https://codeclimate.com/github/webgem-xyz/UVA-React/maintainability)

The UVA is made as a colleberation between students of Mediacollege Amsterdam and the University of Amsterdam. The goal of the project was to create a App to collect marine data.
The UVA is made as a collaboration between students of Mediacollege Amsterdam and the University of Amsterdam. The goal of the project was to create a App to collect marine data.

## Target devices
Our target devices are all recent mobile devices. The devices will not always have a internet connection so the app is required to work offline. Data must be visible offline and when you are offline you should be able to submit data.

| ![Chrome](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/42.4.2/chrome/chrome_48x48.png) | ![Firefox](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/42.4.2/firefox/firefox_48x48.png) | ![Safari](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/42.4.2/safari/safari_48x48.png) | ![Opera](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/42.4.2/opera/opera_48x48.png) | ![Edge](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/42.4.2/edge/edge_48x48.png) |
| --- | --- | --- | --- | --- |
| macOS latest | macOS latest | macOS latest | macOS latest | |
| Windows latest | Windows latest | | Windows latest | Windows latest |
| iOS latest | iOS latest | ios 9.3 and up | - | |
| Android latest | Android latest | | - | |


## Getting Started
To get started clone the respority.
Open the folder in the terminal and run
Expand All @@ -32,18 +40,28 @@ Copyright (c) 2018 Webgem ALL RIGHTS RESERVED

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

## Team
<img src="https://avatars0.githubusercontent.com/u/19853448?s=296&v=4" width="150" height="150" alt="Yannick1691" /> | <img src="https://avatars1.githubusercontent.com/u/25220164?s=296&v=4" width="150" height="150" alt="ThijsvanRijn" /> | <img src="https://avatars1.githubusercontent.com/u/15909945?s=296&v=4" width="150" height="150" alt="Coen" />
--- | --- | ---
[Yannick Frisart](https://github.com/yannick1691) | [Thijs van Rijn](https://github.com/ThijsvanRijn) | [Coen Filipsen](https://github.com/Coen)


# Table of Contents
* [Account Component](#account-component)
* [Add Component](#add-component)
* [AddButton Component](#addbutton-component)
* [AddMedia Component](#addmedia-component)
* [FilterButton Component](#filterbutton-component)
* [Header Component](#header-component)
* [Home Component](#home-component)
* [InputGroup Component](#inputgroup-component)
* [Item Component](#item-component)
* [Login Component](#login-component)
* [Measurement Component](#measurement-component)
* [Media Component](#media-component)
* [Overview Component](#overview-component)
* [ProgressBar Component](#progressbar-component)
* [RemoveButton Component](#removebutton-component)
* [Reset Component](#reset-component)

## Account Component
Expand Down Expand Up @@ -72,6 +90,7 @@ Attribute | Type | Usage
--- | --- | ---
Uid | string | The identifier of the user, used to get the user info etc.
Logout | function | The function to run when the user presses the Sign out button.
Email | string | The email of the user, used to show what account the user is currently logged in to.

## Add Component
### Usage
Expand Down Expand Up @@ -109,7 +128,7 @@ The Add Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
Uid | string | User identifier so it knows where to write to.
addMeasurement | function | The function that handles adding the measurement to the database.

## AddButton Component
### Usage
Expand Down Expand Up @@ -175,7 +194,8 @@ The Add Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
handleImageSubmit | function | The function that handles uploading and handling the media to the database.
AddMeasurement | function | The function that handles adding the media and data to the measurement.
Uid | string | The user identifier used to decide where the image should be uploaded to.

## FilterButton Component
### Usage
Expand Down Expand Up @@ -222,6 +242,51 @@ Title | string | The text that should be displayed on the top of the page.
Accic | boolean | Should there be a account circle to [Account Component](#account-component).
BackColor | string | The color code that the header should have.

## Home Component
### Usage
The Home component consists of the following
* syncstate of measurements
* addMeasurement function
* Router

### Location
The Home Component is located at
```
src/components/home/
```
### Attributes
The Home Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
uid | string | User identifier, used to get the measurements of the specific user.
email | string | Email of the logged in user.
logout | function | The function that handles the logout process.

## InputGroup Component
### Usage
The InputGroup Component consists of the following
* Label
* Input field

### Location
The InputGroup Component is located at
```
src/components/inputGroup/
```
### Attributes
The InputGroup Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
Kind | string | What is the identifier of the input field.
Label | string | What should the label of the input field be.
Value | string | What should the default value of the input field be.
handleState | function | The function that handles user input in the inputfield.
FullWidth | bool | Should the input field be 50% of the width or 100%.
Placeholder | string | What should the placeholder of the input field be.
AutoComplete | string | What should the browser autofill the field with (leave empy to disable autofill).

## Item Component
### Usage
The Item Component consists of the following
Expand Down Expand Up @@ -333,7 +398,45 @@ The Overview Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
Uid | string | Used to get the measurements of the logged in user.
Measurements | object | The measurements of the logged in user.

## ProgressBar Component
### Usage
The ProgressBar Component consists of the following
* Bar wrapper
* Progress bar showing the ammount of progress made

### Location
The ProgressBar Component is located at
```
src/components/progress/
```
### Attributes
The ProgressBar Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
progress | number | How mutch % is uploaded.

## RemoveButton Component
### Usage
The RemoveButton Component consists of the following
* Input field (type button)

### Location
The RemoveButton Component is located at
```
src/components/removeButton/
```
### Attributes
The RemoveButton Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
removeField | function | The function that handles deleting the field.
i | number | Identifier of what field it should remove.
value | string | What should the text in the button be.


## Reset Component
### Usage
Expand All @@ -357,4 +460,4 @@ The Reset Component accepts the following attributes

Attribute | Type | Usage
--- | --- | ---
Reset | function | The function that handles the reset of the password.
Reset | function | The function that handles the reset of the password.
Loading

0 comments on commit 5673fe9

Please sign in to comment.