README.md

🫧 Memo

An minimal AI powered note taking app built with MERN and Gemini.

📦 Technologies

• Vite
• Tailwind CSS
• Firebase
• MERN
• Gemini

✨ Features

• Simple: Memo is designed to be minimal, using it is a breeze.

• AI Powered: Memo uses AI to help you write better notes and documents.

• User Authentication: Users can securely sign in and access notes with Firebase Auth integrated with JWT.

• Search Functionality: Allow users to search notes by keywords, titles, or tags to quickly find information.

• Pin/Unpin Notes: Enable users to pin important notes for quick access and unpin them when no longer needed.

💭 Future Scope

• Markdown: A markdown which has WYSIWYG editor feature.

🚦Running the project:

Prerequisites

Before you begin, ensure you have the following installed on your machine:

• Node.js: Make sure to install Node.js, which includes npm (Node Package Manager).
• MongoDB: Set up a MongoDB database and obtain the connection URL.

Steps

1. Clone the repository:

   git clone https://github.com/bmukesh23/Memo.git

2. Navigate to the project directory:

   cd Memo

3. Install Dependencies:

   cd frontend
   npm install

   cd ../backend
   npm install

4. Set Environment Variables:

   1. Create a .env file in the root of the backend folder of the project.
   2. Add the following environment variables and replace the values with your own:

   VITE_FB_API_KEY=
   VITE_FB_AUTH=
   VITE_FB_PROJECT=
   VITE_FB_STORAGE=
   VITE_FB_MESSAGING=
   VITE_FB_APP=
   VITE_FB_MEASUREMENT=
   VITE_BACKEND_URL=

   1. Create a .env file in the root of the backend folder of the project.
   2. Add the following environment variables and replace the values with your own:

   PORT=
   ACCESS_TOKEN_SECRET=
   MONGODB_URI=
   GEMINI_API_KEY=

5. Run the application:

   cd frontend
   npm run dev

   cd backend
   npm run dev

6. Access the App: Open your web browser and go to http://localhost:5173. You should see the NoteUp Website running locally.