Skip to content

Commit

Permalink
feat: Add splash screen, instructions, tech foundation (#8)
Browse files Browse the repository at this point in the history
Because the learner should know that the app is loading and not frozen,
and easily find instructions when needed,
this commit will:
  - add inital splash screen on load in both browser and PWA
  - add splash animation inline in index.html awaiting App component
  - add barebones instructions overlay
  - add functional navigation bar
  - remove unnecessary scroll bar when NOT on mobile
  - update icons and splash graphics

For the benefit of developer efficiency, this commit will:
  - fix linting
  - use Vuetify.js for layout
  - update @vue/cli and plugins to latest
  - add amplify cfg to Vue.js project
  - move 'push to s3' script into packages.json scripts section
  - move dev wiki to separate repo
  - add yarn versioning and local yarn

Closes #1, #2, #6, #8

Signed-off-by: toshify <4579559+toshify@users.noreply.github.com>
  • Loading branch information
toshify committed Mar 3, 2020
1 parent d8d5fe9 commit 391e469
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 391e469

Please sign in to comment.