Evan Reichard
8e04f51b2d
Downgrade eslint to v8.57.0 and TypeScript to v4.9.5 to match react-scripts@5.0.1 requirements. Force install ajv@8.17.1 and ajv-keywords@5.1.0 to resolve peer dependency conflicts. Add missing dependencies (remark-gfm, rehype-highlight, @testing-library/dom). Update test imports to work with @testing-library/react@16.
Markdown Editor
A WYSIWYG Markdown Editor with live preview, built with Go backend and React/TypeScript frontend.
Features
- Markdown Editor with live GitHub Flavored Markdown preview
- File Management: Create, open, save, and delete markdown files
- Theme System: Dark, Light, and System themes with persistence
- Responsive Design: Works on desktop and mobile
- REST API: Full CRUD operations for markdown files
Project Structure
.
├── backend/
│ ├── cmd/server/
│ │ └── main.go
│ ├── internal/
│ │ ├── api/
│ │ │ ├── server.go
│ │ │ └── server_test.go
│ │ └── storage/
│ │ ├── storage.go
│ │ └── storage_test.go
│ ├── pkg/
│ │ └── logger/
│ │ └── logger.go
│ └── go.mod
├── frontend/
│ ├── src/
│ │ ├── components/
│ │ ├── hooks/
│ │ ├── lib/
│ │ ├── types/
│ │ ├── App.tsx
│ │ ├── App.test.tsx
│ │ ├── index.css
│ │ └── index.tsx
│ ├── public/
│ ├── package.json
│ ├── tsconfig.json
│ └── tailwind.config.js
├── flake.nix
├── flake.lock
└── SPEC.md
Development
Using Nix
The project uses Nix for development environment. Ensure you have Nix installed.
# Start development shell
nix-shell
# Run tests
cd backend && go test ./...
cd ../frontend && npm test
Backend
cd backend
# Run server with defaults
go run cmd/server/main.go
# Run with custom settings
go run cmd/server/main.go --data-dir ./data --port 8080 --host 127.0.0.1
# Run tests
go test ./...
Frontend
cd frontend
# Install dependencies (in nix-shell)
npm install
# Start development server
npm start
# Build for production
npm run build
# Run tests
npm test
API Endpoints
GET /api/files- List all markdown filesPOST /api/files- Create a new filePUT /api/files/:filename- Update a fileDELETE /api/files/:filename- Delete a file/- Serve frontend (SPA fallback)/static/*- Serve static assets
Testing
Run all tests:
# Backend
cd backend && go test -v ./...
# Frontend
cd frontend && npm test
Evaluation Checklist
- CLI starts with defaults
- CRUD works end-to-end
- Static assets are properly served
- Theme switch & persistence
- Responsive at 320px and 1920px