Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bmukesh23/memo
🫧 An minimal AI powered note taking app built with MERN & Gemini.
https://github.com/bmukesh23/memo
axios express firebase-auth gemini gemini-15-flash gemini-api jwt mern mongodb node react tailwindcss vite
Last synced: 2 days ago
JSON representation
🫧 An minimal AI powered note taking app built with MERN & Gemini.
- Host: GitHub
- URL: https://github.com/bmukesh23/memo
- Owner: bmukesh23
- Created: 2024-05-12T15:08:57.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-07-09T08:29:07.000Z (6 months ago)
- Last Synced: 2024-07-09T10:57:08.921Z (6 months ago)
- Topics: axios, express, firebase-auth, gemini, gemini-15-flash, gemini-api, jwt, mern, mongodb, node, react, tailwindcss, vite
- Language: JavaScript
- Homepage: https://memoo-note.vercel.app
- Size: 3.35 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🫧 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](https://nodejs.org/): Make sure to install Node.js, which includes npm (Node Package Manager).
- [MongoDB](https://www.mongodb.com/try/download/community): Set up a MongoDB database and obtain the connection URL.
## Steps
1. **Clone the repository:**
```bash
git clone https://github.com/bmukesh23/Memo.git
```
2. **Navigate to the project directory:**
```bash
cd Memo
```
3. **Install Dependencies:**
```bash
cd frontend
npm install
```
```bash
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:
```env
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:
```env
PORT=
ACCESS_TOKEN_SECRET=
MONGODB_URI=
GEMINI_API_KEY=
```
5. **Run the application:**
```bash
cd frontend
npm run dev
```
```bash
cd backend
npm run dev
```
6. **Access the App:**
Open your web browser and go to [http://localhost:5173](http://localhost:5173). You should see the NoteUp Website running locally.