my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

my-project-public — gitlawb

#1	# OpenMemory API
#2
#3	This directory contains the backend API for OpenMemory, built with FastAPI and SQLAlchemy. This also runs the Mem0 MCP Server that you can use with MCP clients to remember things.
#4
#5	## Quick Start with Docker (Recommended)
#6
#7	The easiest way to get started is using Docker. Make sure you have Docker and Docker Compose installed.
#8
#9	1. Build the containers:
#10	```bash
#11	make build
#12	```
#13
#14	2. Create `.env` file:
#15	```bash
#16	make env
#17	```
#18
#19	Once you run this command, edit the file `api/.env` and enter the `OPENAI_API_KEY`.
#20
#21	3. Start the services:
#22	```bash
#23	make up
#24	```
#25
#26	The API will be available at `http://localhost:8765`
#27
#28	### Common Docker Commands
#29
#30	- View logs: `make logs`
#31	- Open shell in container: `make shell`
#32	- Run database migrations: `make migrate`
#33	- Run tests: `make test`
#34	- Run tests and clean up: `make test-clean`
#35	- Stop containers: `make down`
#36
#37	## API Documentation
#38
#39	Once the server is running, you can access the API documentation at:
#40	- Swagger UI: `http://localhost:8765/docs`
#41	- ReDoc: `http://localhost:8765/redoc`
#42
#43	## Project Structure
#44
#45	- `app/`: Main application code
#46	- `models.py`: Database models
#47	- `database.py`: Database configuration
#48	- `routers/`: API route handlers
#49	- `migrations/`: Database migration files
#50	- `tests/`: Test files
#51	- `alembic/`: Alembic migration configuration
#52	- `main.py`: Application entry point
#53
#54	## Development Guidelines
#55
#56	- Follow PEP 8 style guide
#57	- Use type hints
#58	- Write tests for new features
#59	- Update documentation when making changes
#60	- Run migrations for database changes
#61

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public