Skip to content

Latest commit

 

History

History
147 lines (105 loc) · 4.55 KB

README.md

File metadata and controls

147 lines (105 loc) · 4.55 KB
Raw

Welcome to DocuThinker Mobile - A React Native, Expo App 👋

The DocuThinker Mobile app is a React Native app built with Expo. It's a mobile app that helps you manage your documents and notes on the go.

Table of contents

Features

  • Document management: Create, edit, and delete documents.
  • Note-taking: Write and save notes.
  • Search: Find documents and notes quickly.
  • Dark mode: Switch between light and dark themes.
  • Offline support: Use the app without an internet connection.
  • Cross-platform: Run the app on Android, iOS, and the web.
  • Authentication: Sign in with your Google account.
  • Real-time updates: See changes in real-time with Firebase Firestore.
  • Push notifications: Get notified when a document is shared with you.
  • Localization: Use the app in multiple languages.
  • Accessibility: Navigate the app with screen readers.

Technologies

  • React Native: Build mobile apps with JavaScript and React.
  • Expo: Develop and build React Native apps quickly.
  • Firebase: Use Firebase services like Firestore, Authentication, and Cloud Messaging.
  • React Navigation: Navigate between screens in the app.
  • Redux Toolkit: Manage app state with Redux Toolkit.
  • React Hook Form: Handle form state and validation.

User Interface

The app uses the Material Design system for its user interface. It follows the Material Design guidelines for components, typography, and color schemes.

Landing Page

DocuThinker Mobile

Navigation Drawer

DocuThinker Mobile

Document List

DocuThinker Mobile

How to Use Page

DocuThinker Mobile

Get Started

  1. Install dependencies

    npm install

  2. Start the app

     npx expo start

In the output, you'll find options to open the app in a

You can start developing by editing the files inside the app directory. This project uses file-based routing.

Get a Fresh Project

When you're ready, run:

npm run reset-project

This command will move the starter code to the app-example directory and create a blank app directory where you can start developing.

Future Plans

I am actively working to release on the Google Play Store and Apple App Store are in the works. Stay tuned for updates!

Learn More

Contributing

Contributions are welcome! Here's how you can help:

  1. Clone the repository:

    # Clone the repository
git clone git clone https://github.com/hoangsonww/DocuThinker-AI-App.git
cd DocuThinker-AI-App/mobile-app

  2. Create a new branch:

     git checkout -b feature/your-branch-name

  3. Make your changes and commit them:

     git add .
 git commit -m 'Add some feature'

  4. Push to the original branch:

    git push origin feature/your-branch-name

  5. Create a pull request in GitHub.

  6. Enjoy your contribution!

License

This project is licensed under the CC-BY-NC 4.0 - see the LICENSE file for details.

Made with ❤️ by Son Nguyen in 2024.