Skip to content

Commit

Permalink
[#8] Adds splash screen, instructions overlay, technology foundation
Browse files Browse the repository at this point in the history
PR #8
Issue #1, #2, #6, #8

✔️ **All tests passing!**

- adds inital splash screen on load both in browser and in PWA from
  phone's start screen.
- adds splash animation inline in index.html awaiting App component
- adds proper TypeScrip formatting
- adds linting
- generates icons and splash with pwa-assets-generator
- adds delay to mount if time since navStart>2000
- configures splash delay to only delay in prod
- aligns ios splash with loader ani
- adds vuetify material design and get instructions graphic
- adds vuetify svg icons as well as font icons
- configures vuetify to use mdiSvg
- configures vuetify to make custom properties available for css
- updates Home to use vuetify for layout
- moves push to s3 script into packages.json scripts section
- gets eslint in vscode working (see .eslinrc.js)
- adds html overflow-y auto to index to avoid scroll bar when NOT on
mobile
- adds functional navigation bar
- adds typescript shims for handling svg files as objects
- updates @vue/cli and plugins to latest
- adds yarn versioning and local yarn
- adds workspace cfg and starts trigger on instructions button
- adds amplify cfg at root

All tests passing!
  • Loading branch information
toshify committed May 14, 2021
1 parent e603920 commit b4805bf
Show file tree
Hide file tree
Showing 223 changed files with 151,431 additions and 1,788 deletions.
56 changes: 52 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,55 @@

A mobile-first literacy webapp for adult Chinese.

* [TODO](wiki/TODO.md)
* [Infrastructure](wiki/infrastructure.md)
* [Resources](wiki/resources.md)
* [Setup](wiki/setup.md)
## Development

```sh
# Install git
sudo apt install git

# Clone this git repo
git clone git@github.com:toshify/shizi.git target-dir

# Install [NVM](https://github.com/nvm-sh/nvm) to handle node versions (ensure v#.##.# is latest version):
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

# Reload terminal
exit
Ctrl-Alt-T
# or instead
source ~/.bashrc

# Then install latest Node LTS
nvm install --lts

# Install [yarn](https://yarnpkg.com/getting-started/install) globally
npm install -g yarn

# Navigate to repo
cd shizi/vue # or target-dir/vue or target-dir/react

# Install packages
yarn # equivalent of: yarn install

# Start the app in local demo
yarn start
```

## Update tools

### NVM
Re-install [NVM](https://github.com/nvm-sh/nvm) to update (ensure v#.##.# is latest version):
```sh
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
```

### Node
```sh
nvm install --lts
```

### Yarn
```sh
yarn set version latest
```

43 changes: 43 additions & 0 deletions asset-sources/booksprout-bg-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions asset-sources/booksprout-bg.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions asset-sources/booksprout-col.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added asset-sources/booksprout.afdesign
Binary file not shown.
Loading

0 comments on commit b4805bf

Please sign in to comment.