This client was built for the ASU Hacks For Humanity 2018 hackathon. It's part of a platform that provides an accessible a 'penpal' platform that allows elderly user to connect with others via email with speech to text email sending.
To be used with the reParent API
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them
git
yarn
A step by step series of examples that tell you how to get a development env running
- Clone this repository
git clone [email protected]:jsullivan5/hack-for-humanity-2018_client.git
- Navigate to project root
cd hack-for-humanity-2018_client
- Install packages
yarn install
- Start development server with hot reloading
yarn start
- If the packages were installed, eslint is already configured.
- Follow the instructions for your text editor to install eslint to use it. Atom
Lint from the command line
npm run lint
-
Always branch off of
master
-
Always work on a branch
git branch my-branch
-
update branch off master with
git rebase
. This puts your commits on top of other's and creates a cleaner commit historygit pull origin master --rebase
- There may be merge conflicts...
- If so, look in text editor and figure out what should be merged
- After fixing, add commits to staging with
git add .
- Continue with rebase with
git rebase --continue
- Repeat until your recent commits are applied
- Sometimes git is terrible and will not run the continue command.
- If it's been tried a couple times and is not working, don't be afraid to
git rebase --skip
- If it's been tried a couple times and is not working, don't be afraid to
- And if all
hell
breaks loose:git rebase --abort
and try again...
- There may be merge conflicts...
-
Don't work on a branch for too long. It's hard to review and incurs more merge conflicts
-
Push branches up to Github and create pull requests
git push origin my-branch
- Pull requests can and should be reviewed by another developer before merging. Tag someone in the
reviewers
section on the right.
Coming soon...
Coming soon...
Coming soon...
- React.js - Framework used
- Create React App Redux Boilerplate - Speech to Text API
- Watson Speech - Watson Speech client
-
Arizona State University
-
Hack for Humanity 2018
-
Tutorial: Getting started with create-react-app, Redux, React Router & Redux Thunk
-
Demo ๐