Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 5 KB

README.md

File metadata and controls

104 lines (75 loc) · 5 KB

Commit logo

commit

Developer tooling for the Frappeverse 🪐

Install on Frappe Cloud »

Learn More »

Issues . Sponsor Us!

license Github Stars Commits-per-month

commit

Born out of a need to improve developer tooling for Frappe, "Commit" allows you to visualize your app's database schema and view all its APIs, generate documentation for the APIs, and manage your documentation through Commit Docs - improving developer productivity and security of your critical applications.

Basic Installation

The below guide assumes that you already have a working Frappe and Bench installation. If you do not have it, then please head over to Official Installation Guide.

Go ahead and create a fresh new bench:

# Initialize a new bench
bench init commit
# Get the Commit app
bench get-app https://github.com/The-commit-company/commit
# Create a new site
bench new-site my-site.localhost
# Install the Commit app on the site
bench --site my-site.localhost install-app commit

Tech Stack

Common Across Web and Mobile

  • Frappe Framework: An open-source full-stack development framework using Python, MariaDB/Postgres, socket.io, and Redis.
  • React: A JavaScript library for building user interfaces.
  • Frappe React SDK: A React Hooks library for handling auth, data fetching, and API calls to the Frappe Framework backend.
  • Tailwind CSS: A utility-first CSS framework.
  • MDX: A Markdown format that allows you to use JSX components in your Markdown files.
  • OpenAI API: For AI-assisted documentation generation and editing.

Production Setup

Managed Hosting

You can try Frappe Cloud, a simple, user-friendly, and sophisticated open-source platform to host Frappe applications with peace of mind.

It takes care of installation, setup, upgrades, monitoring, maintenance, and support of your Frappe deployments. It is a fully featured developer platform with the ability to manage and control multiple Frappe deployments.

Try on Frappe Cloud Screenshot 2025-04-02 at 6 35 01 PM

Key Features

  • Database Schema Visualization: View and analyze your application's database structure graphically.Screenshot 2025-04-02 at 6 34 50 PM

  • API Explorer: Easily access and test API endpoints within the Frappe framework.imageimage

  • Command Reference: Get an overview of available Frappe commands.

  • image

  • Documentation Generation: Auto-generate API documentation.image

  • OpenAI Integration: Edit and refine documentation using AI assistance.

  • Commit Docs: Manage and publish documentation for your applications.image

  • Docs Dashboard: View and manage all your documentation in one place.

  • image

  • MDX Support: Write JavaScript and React components in your Markdown files.

  • image

  • Customizable: Tailor the tool to fit your specific needs and preferences.