Skip to content

As "simpli" as its name. Use πŸ’«Simpli-noteπŸ’« to quickly create your notes...πŸ“’

Notifications You must be signed in to change notification settings

betanyeli/simpli-note

Repository files navigation

Logo

Simpli Note

As "simpli" as its name. Use πŸ’«Simpli-noteπŸ’« to quickly create your notes...πŸ“’

πŸ“Έ Screenshots πŸ“Έ

Android

iOS

✨ Features ✨

  • Notes viewer
  • Add note fancy textbox
  • Detail notes
  • Clear notes
  • Back button save support V1
  • Tags (View only)
  • Custom components
    • Modal
    • Tags
    • Snackbar
    • Button
  • Unit test (Snapshots) V1

πŸ”œ Roadmap

  • Back button save support V2
  • Pull to refresh
  • Skeleton or loaders
  • Android icons support.
  • Refresh after clear async storage

πŸ›  Tech Stack πŸ› 

  • React Native v0.71.4
  • Async Storage v1.17.11
  • React navigation v6
  • TypeScript v4.8.4
  • Jest
  • React native testing library
  • React custom hooks & context

πŸ–Œ UI Inspiration

  • Logo: Inspired in Mainteny πŸ‡©πŸ‡ͺ assets and builded in Figma.
  • SplashScreen: Inspired in Mainteny πŸ‡©πŸ‡ͺ assets and builded in Figma.
  • Color palette: Mainteny πŸ‡©πŸ‡ͺ UI Colors.
  • FontFamily: Mainteny πŸ‡©πŸ‡ͺ font - Google Font Manrope
  • UI Notes Mobile App

πŸ“ Folder structure

└── src/
    β”œβ”€β”€ assets/
    β”‚   └── fonts
    └── components/
        β”œβ”€β”€ atoms/
        β”‚   β”œβ”€β”€ button
        β”‚   β”œβ”€β”€ header
        β”‚   β”œβ”€β”€ onboarding-title
        β”‚   β”œβ”€β”€ separator
        β”‚   β”œβ”€β”€ snackbar
        β”‚   └── textArea
        β”œβ”€β”€ molecules/
        β”‚   β”œβ”€β”€ confirmation-modal
        β”‚   β”œβ”€β”€ notes-slider
        β”‚   └── tag-slider
        β”œβ”€β”€ dummyData
        β”œβ”€β”€ helpers
        β”œβ”€β”€ hooks/
        β”‚   β”œβ”€β”€ service
        β”‚   └── theme
        β”œβ”€β”€ navigation
        β”œβ”€β”€ screens/
        β”‚   β”œβ”€β”€ add-note
        β”‚   β”œβ”€β”€ detail-note
        β”‚   └── onboarding
        β”œβ”€β”€ wrapper.tsx
        └── styles

πŸš€ Run Locally

Clone the project

  git clone https://github.com/betanyeli/simpli-note.git

Go to the project directory

  cd simpli-note

Install dependencies

  yarn install
  cd ios && pod install

Start the server

  yarn start

Run Android simulator

  yarn run android

Run iOS simulator

  yarn run ios

Running Tests

To run tests, run the following command

  yarn test

Or run linter

  yarn lint

πŸš€ Deployment πŸš€

To generate APK of this project run

  npx react-native bundle --platform android --dev false \
  --entry-file index.js \
  --bundle-output android/app/src/main/assets/index.android.bundle \
  --assets-dest android/app/src/main/res/

discard generated changes, and then

  cd android && ./gradlew assembleRelease

πŸ‘©πŸ»β€πŸ’» Author πŸ‘©πŸ»β€πŸ’»

Develop with love by πŸ’•@BetaπŸ’•

Feedback

πŸ™‰Your feedback is my salaryπŸ™‰, just kidding! . If you have any comments, suggestions, let me know πŸͺ

About

As "simpli" as its name. Use πŸ’«Simpli-noteπŸ’« to quickly create your notes...πŸ“’

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published