NoteInk - AI-Powered Note-Taking App

Welcome to NoteInk, a modern AI-powered note-taking application built using a monorepo structure with Next.js for the web and Expo for the mobile application. NoteInk combines a sleek, user-friendly interface with an intelligent AI assistant to enhance your note-taking experience.

Features

• AI Assistant: Leverage the power of an AI assistant to answer queries, summarize content, or assist with note organization.
• Cross-Platform: Seamless experience on both web and mobile platforms.
• Simple UI: Intuitive and accessible design, suitable for users of all levels.
• Fast Setup: Quick and easy setup for developers to get started with the codebase.

Prerequisites

Before setting up the project, ensure you have the following installed:

• Node.js (v16 or higher)
• npm or yarn
• Git
• A Gemini API Key (obtainable for free from Google AI Studio)

Setup Instructions

To get started, clone the repository by running the following command in your terminal:

git clone https://github.com/Dawood-0007/AI-powered-Note-App-NoteInk.git

The repository contains two folders in the apps directory: one for the mobile app (mobile/NoteInk) and one for the web app (web/noteink).

To see app running you can also download apk from the link here -- only for android.

As well as, you can visit website to see the web version here

Mobile App Setup

1. Navigate to the mobile app directory:

   cd ./apps/mobile/NoteInk

2. Install dependencies:

   npm install

3. Start the Expo development server:

   npx expo start

   This will launch the mobile app in development mode. You can scan the QR code with the Expo Go app on your mobile device or run it on an emulator.

For further details you can visit expo documentaion here

Web App Setup

1. Navigate to the web app directory:

   cd ./apps/web/noteink

2. Install dependencies:

   npm install

3. Create a .env file in the web/noteink directory and add your Gemini API key:

   GEMINI_API_KEY=your-gemini-api-key

4. Start the Next.js development server:

   npm run dev

   The web app should now be running on http://localhost:3000 (or another port if specified).

For further details you can visit nextjs documentaion here

Contributing

We warmly welcome contributions to NoteInk! Whether it's a bug fix, feature addition, or documentation improvement, your efforts will help make NoteInk better for everyone. To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature-name).
3. Make your changes and commit them (git commit -m "Add your message here").
4. Push to your branch (git push origin feature/your-feature-name).
5. Open a pull request on GitHub.

Please ensure your code follows the project's coding standards and includes appropriate tests.

Issues and Feedback

If you encounter any issues or have suggestions for improvement, please create an issue on the GitHub repository. We appreciate your feedback!