Skip to content

Commit

Permalink
docs(readme): add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
craftzdog committed Nov 14, 2021
1 parent 7dc0833 commit adf978d
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Smoothly Animated ToDo App built with React Native

![Thumbnail](./doc/thumb.jpg)

Try the demo on [![Expo Go](./doc/expo-logo.svg)](https://expo.dev/@craftzdog/animated-todo)

The animated checkbox component has been published as [an NPM module `react-native-checkbox-reanimated`](https://github.com/craftzdog/react-native-checkbox-reanimated).

![demo](./doc/checkbox.gif)

## Tutorial

Watch how I built this website on YouTube: [<img src="./doc/youtube.png" width="32" />](https://youtu.be/k2h7usLLBhY)

## Stack

- [React Native](https://reactnative.dev/) - ReactJS-based framework that can use native platform capabilities
- [Expo](https://expo.dev/) - Toolset for building and delivering RN apps
- [React Navigation(v6)](https://reactnavigation.org/) - Routing and navigation
- [NativeBase(v3)](https://nativebase.io/) - Themable component library
- [React Native Reanimated](https://docs.swmansion.com/react-native-reanimated/) - Animations
- [React Native SVG](https://github.com/react-native-svg/react-native-svg) - Drawing SVG
- [Moti](https://moti.fyi/) - Helper module for Reanimated 2

## Project structure

```
$PROJECT_ROOT
├── App.tsx # Entry point
└── src
├── screens # Screen components
├── components # UI components
├── utils # Custom hooks and helpers
└── assets # Image files
```

## Credits

- [SALY 3D Illustration Pack](https://www.figma.com/community/file/890095002328610853)
- [Animated SVG stroke example by William Candillon](https://github.com/wcandillon/can-it-be-done-in-react-native/tree/master/reanimated-2/src/StrokeAnimation)

## How to dev

This project can be run from the Expo client app.

```sh
yarn
yarn start
```

---

Looking for a Markdown note-taking app? Check out my app called Inkdrop:

[![Inkdrop](https://github.com/craftzdog/dotfiles-public/raw/master/images/inkdrop.png)](https://www.inkdrop.app/)
Binary file added doc/checkbox.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/expo-logo.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 doc/thumb.jpg
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 doc/youtube.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit adf978d

Please sign in to comment.