my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

my-project-public — gitlawb

#1	# OpenMemory
#2
#3	OpenMemory is your personal memory layer for LLMs - private, portable, and open-source. Your memories live locally, giving you complete control over your data. Build AI applications with personalized memories while keeping your data secure.
#4
#5	![OpenMemory](https://github.com/user-attachments/assets/3c701757-ad82-4afa-bfbe-e049c2b4320b)
#6
#7	## Easy Setup
#8
#9	### Prerequisites
#10	- Docker
#11	- OpenAI API Key
#12
#13	You can quickly run OpenMemory by running the following command:
#14
#15	```bash
#16	curl -sL https://raw.githubusercontent.com/mem0ai/mem0/main/openmemory/run.sh \| bash
#17	```
#18
#19	You should set the `OPENAI_API_KEY` as a global environment variable:
#20
#21	```bash
#22	export OPENAI_API_KEY=your_api_key
#23	```
#24
#25	You can also set the `OPENAI_API_KEY` as a parameter to the script:
#26
#27	```bash
#28	curl -sL https://raw.githubusercontent.com/mem0ai/mem0/main/openmemory/run.sh \| OPENAI_API_KEY=your_api_key bash
#29	```
#30
#31	## Prerequisites
#32
#33	- Docker and Docker Compose
#34	- Python 3.9+ (for backend development)
#35	- Node.js (for frontend development)
#36	- OpenAI API Key (required for LLM interactions, run `cp api/.env.example api/.env` then change OPENAI_API_KEY to yours)
#37
#38	## Quickstart
#39
#40	### 1. Set Up Environment Variables
#41
#42	Before running the project, you need to configure environment variables for both the API and the UI.
#43
#44	You can do this in one of the following ways:
#45
#46	- Manually:
#47	Create a `.env` file in each of the following directories:
#48	- `/api/.env`
#49	- `/ui/.env`
#50
#51	- Using `.env.example` files:
#52	Copy and rename the example files:
#53
#54	```bash
#55	cp api/.env.example api/.env
#56	cp ui/.env.example ui/.env
#57	```
#58
#59	- Using Makefile (if supported):
#60	Run:
#61
#62	```bash
#63	make env
#64	```
#65	- #### Example `/api/.env`
#66
#67	```env
#68	OPENAI_API_KEY=sk-xxx
#69	USER=<user-id> # The User Id you want to associate the memories with
#70	```
#71	- #### Example `/ui/.env`
#72
#73	```env
#74	NEXT_PUBLIC_API_URL=http://localhost:8765
#75	NEXT_PUBLIC_USER_ID=<user-id> # Same as the user id for environment variable in api
#76	```
#77
#78	### 2. Build and Run the Project
#79	You can run the project using the following two commands:
#80	```bash
#81	make build # builds the mcp server and ui
#82	make up # runs openmemory mcp server and ui
#83	```
#84
#85	After running these commands, you will have:
#86	- OpenMemory MCP server running at: http://localhost:8765 (API documentation available at http://localhost:8765/docs)
#87	- OpenMemory UI running at: http://localhost:3000
#88
#89	#### UI not working on `localhost:3000`?
#90
#91	If the UI does not start properly on [http://localhost:3000](http://localhost:3000), try running it manually:
#92
#93	```bash
#94	cd ui
#95	pnpm install
#96	pnpm dev
#97	```
#98
#99	### MCP Client Setup
#100
#101	Use the following one step command to configure OpenMemory Local MCP to a client. The general command format is as follows:
#102
#103	```bash
#104	npx @openmemory/install local http://localhost:8765/mcp/<client-name>/sse/<user-id> --client <client-name>
#105	```
#106
#107	Replace `<client-name>` with the desired client name and `<user-id>` with the value specified in your environment variables.
#108
#109
#110	## Project Structure
#111
#112	- `api/` - Backend APIs + MCP server
#113	- `ui/` - Frontend React application
#114
#115	## Contributing
#116
#117	We are a team of developers passionate about the future of AI and open-source software. With years of experience in both fields, we believe in the power of community-driven development and are excited to build tools that make AI more accessible and personalized.
#118
#119	We welcome all forms of contributions:
#120	- Bug reports and feature requests
#121	- Documentation improvements
#122	- Code contributions
#123	- Testing and feedback
#124	- Community support
#125
#126	How to contribute:
#127
#128	1. Fork the repository
#129	2. Create your feature branch (`git checkout -b openmemory/feature/amazing-feature`)
#130	3. Commit your changes (`git commit -m 'Add some amazing feature'`)
#131	4. Push to the branch (`git push origin openmemory/feature/amazing-feature`)
#132	5. Open a Pull Request
#133
#134	Join us in building the future of AI memory management! Your contributions help make OpenMemory better for everyone.
#135

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public