41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
# MOBILE app project
|
|
|
|
This is a mobile app project, it is like a letter card for children to learn vocabularies
|
|
|
|
## Tech Stack
|
|
|
|
- TypeScript 5
|
|
- ionic 8
|
|
- capacitor
|
|
- react 18
|
|
- typescript 5
|
|
- vite 5
|
|
|
|
## Directory Structure
|
|
|
|
When introducing changes to the project, always follow the directory structure below:
|
|
|
|
- `./src` - source code
|
|
- `./src/scripts` - developer scripts
|
|
- `./public` - public assets
|
|
- `./cypress` - cypress tests
|
|
- `./android` - android app source code by ionic
|
|
|
|
When modifying the directory structure, always update this section.
|
|
|
|
## Guidelines
|
|
|
|
- this is an ionic capacitor app
|
|
- this is the link to ionic docs <https://ionicframework.com/docs/capacitor>
|
|
- this is the link to ionic react docs <https://ionicframework.com/docs/react>
|
|
- use typescript and vite
|
|
- don't use any other framework unless specifically requested
|
|
- use ionic platform specific components
|
|
- use ionic platform specific router
|
|
- use `async await` for promises
|
|
- use `async await` for async functions with `try` `catch`
|
|
- readme.md should be in the root directory
|
|
- readme.md should use markdown
|
|
- readme.md should explain the purpose of the application, the project structure, and the technologies used, adn link to the documentation for each technology
|
|
- readme.md should explain the values in the .env file
|