Skip to content

update readme because it was really needed #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nikkothari22 merged 1 commit into from
Sep 14, 2024
Merged

update readme because it was really needed #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
# commit
## commit
# [commit](https://commit.frappe.cloud/)

The Commit Company
Born out of a need to improve developer tooling for Frappe, "Commit" allows you to visualize your app's database schema and view all it's APIs - 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](https://frappeframework.com/docs/user/en/installation).

Go ahead and create a fresh new bench

- `bench init commit`
- `bench get-app https://github.com/The-commit-company/commit`
- `bench new-site <preferred-site-url>`
- `bench --site <site-url> install-app commit`

Commit will now be accessible on https://<site-url>:8000/commit.