https://github.com/stevndegwa/notes-app
Notes taking application
https://github.com/stevndegwa/notes-app
animation framer-motion functional-testing indexeddb playwright reactjs recoil srp web-components
Last synced: 3 months ago
JSON representation
Notes taking application
- Host: GitHub
- URL: https://github.com/stevndegwa/notes-app
- Owner: StevNdegwa
- Created: 2021-06-16T09:03:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T07:59:15.000Z (almost 2 years ago)
- Last Synced: 2025-02-13T18:31:07.059Z (5 months ago)
- Topics: animation, framer-motion, functional-testing, indexeddb, playwright, reactjs, recoil, srp, web-components
- Language: TypeScript
- Homepage: https://notes-taking-app100.netlify.app/
- Size: 2.11 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Notes App
An application to take notes.
### Tech stack
- [Typescript](https://www.typescriptlang.org/) programming language
- [React](https://reactjs.org/) web framework
- [Styled Components](https://styled-components.com/) for styling
- [React hook form](https://react-hook-form.com/) for creating forms
- [React router dom](https://v5.reactrouter.com/) for application routing
- [Framer Motion](https://www.framer.com/motion/) for handling animations
- [Dexie](https://dexie.org/) IndexedDB framework
- [Editor.js](https://editorjs.io/) editor
### Application structure
Applies clean architecture principles
- **src/application**
contains app login
- Shared state (recoil and react context)
- Business logic
- **src/infrastructure** contains app infrastructure setup
- Database (IndexedDB) configuration
- **src/presentation**
Contains ui (React) components. Follows the atomic design principles
- common has reusable components - mainly atoms and molecules
- pages has the components for the pages
- **src/shared**
Contains shared code
- interfaces
- enums
- **src/ui**
Contains styling and themes code
- style
- theme
- **src/utils**
Utilities library
### Hosted
Hosted on netlify
Uses Netlify CI/CD
## Authors
- [@StevNdegwa](https://github.com/StevNdegwa)
## Acknowledgements
- [Awesome Readme Templates](https://awesomeopensource.com/project/elangosundar/awesome-README-templates)
- [Awesome README](https://github.com/matiassingers/awesome-readme)
- [How to write a Good readme](https://bulldogjob.com/news/449-how-to-write-a-good-readme-for-your-github-project)