chore: update readme (#28819)
This commit is contained in:
Sumit Bhanushali
GitHub
parent
ea49c2500c
commit
051cedb860
6 changed files with 133 additions and 49 deletions
14
.github/framework-logo-new.svg
vendored
Normal file
14
.github/framework-logo-new.svg
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
<svg width="117" height="117" viewBox="0 0 117 117" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<g clip-path="url(#clip0_1144_67)">
|
||||
<path d="M93.4394 0H23.5606C10.5485 0 0 10.5485 0 23.5606V93.4394C0 106.452 10.5485 117 23.5606 117H93.4394C106.452 117 117 106.452 117 93.4394V23.5606C117 10.5485 106.452 0 93.4394 0Z" fill="#909090"/>
|
||||
<path d="M87.1655 75.4V41.8L58.0828 25L29 41.8V75.4L58.0828 92.2L87.1655 75.4Z" stroke="white" stroke-width="10.59" stroke-linecap="round" stroke-linejoin="round"/>
|
||||
<path d="M29 41.8003L58.0828 58.6003L87.1655 41.8003" stroke="white" stroke-width="10.59" stroke-linecap="round" stroke-linejoin="round"/>
|
||||
<path d="M58.083 58.6006V92.2006" stroke="white" stroke-width="10.59" stroke-linecap="round" stroke-linejoin="round"/>
|
||||
<path d="M37.5 59L19 48" stroke="#909090" stroke-width="10.59"/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_1144_67">
|
||||
<rect width="117" height="117" fill="white"/>
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 942 B |
BIN
.github/fw-form-view.png
vendored
Normal file
BIN
.github/fw-form-view.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 876 KiB |
BIN
.github/fw-list-view.png
vendored
Normal file
BIN
.github/fw-list-view.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 950 KiB |
BIN
.github/fw-rpm.png
vendored
Normal file
BIN
.github/fw-rpm.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 940 KiB |
BIN
.github/hero-image.png
vendored
Normal file
BIN
.github/hero-image.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 949 KiB |
168
README.md
168
README.md
|
|
@ -1,66 +1,136 @@
|
|||
<div align="center">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset=".github/frappe-framework-logo-dark.svg">
|
||||
<img src=".github/frappe-framework-logo.svg" height="50">
|
||||
</picture>
|
||||
<h3>
|
||||
a web framework with <a href="https://www.youtube.com/watch?v=LOjk3m0wTwg">"batteries included"</a>
|
||||
</h3>
|
||||
<h5>
|
||||
it's pronounced - <em>fra-pay</em>
|
||||
</h5>
|
||||
<div align="center" markdown="1">
|
||||
<img src=".github/framework-logo-new.svg" width="80" height="80"/>
|
||||
<h1>Frappe Framework</h1>
|
||||
|
||||
**Low Code Web Framework For Real World Applications, In Python And JavaScript**
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
<a target="_blank" href="#LICENSE" title="License: MIT"><img src="https://img.shields.io/badge/License-MIT-success.svg"></a>
|
||||
<a target="_blank" href="https://www.python.org/downloads/" title="Python version"><img src="https://img.shields.io/badge/python-%3E=_3.10-success.svg"></a>
|
||||
<a href="https://frappeframework.com/docs"><img src="https://img.shields.io/badge/docs-%F0%9F%93%96-success.svg"/></a>
|
||||
<a href="https://github.com/frappe/frappe/actions/workflows/server-tests.yml"><img src="https://github.com/frappe/frappe/actions/workflows/server-tests.yml/badge.svg"></a>
|
||||
<a href="https://github.com/frappe/frappe/actions/workflows/ui-tests.yml"><img src="https://github.com/frappe/frappe/actions/workflows/ui-tests.yml/badge.svg?branch=develop"></a>
|
||||
<a href="https://codecov.io/gh/frappe/frappe"><img src="https://codecov.io/gh/frappe/frappe/branch/develop/graph/badge.svg?token=XoTa679hIj"/></a>
|
||||
</div>
|
||||
|
||||
|
||||
Full-stack web application framework that uses Python and MariaDB on the server side and a tightly integrated client side library. Built for [ERPNext](https://erpnext.com).
|
||||
|
||||
<div align="center" style="max-height: 40px;">
|
||||
<a href="https://frappecloud.com/frappe/signup"><img src=".github/try-on-f-cloud-button.svg" height="40"></a>
|
||||
<a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/gavindsouza/install-scripts/main/frappe/pwd.yml"><img src="https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png" alt="Try in PWD" height="37"/></a>
|
||||
<div align="center">
|
||||
<img src=".github/hero-image.png" alt="Hero Image" />
|
||||
</div>
|
||||
<div align="center">
|
||||
<a href="https://frappe.io/framework">Website</a>
|
||||
-
|
||||
<a href="https://docs.frappe.io/framework">Documentation</a>
|
||||
</div>
|
||||
|
||||
> Login for the PWD site: (username: Administrator, password: admin)
|
||||
## Frappe Framework
|
||||
Full-stack web application framework that uses Python and MariaDB on the server side and a tightly integrated client side library. Built for ERPNext.
|
||||
|
||||
## Table of Contents
|
||||
* [Installation](#installation)
|
||||
* [Contributing](#contributing)
|
||||
* [Resources](#resources)
|
||||
* [License](#license)
|
||||
### Motivation
|
||||
Started in 2005, Frappe Framework was inspired by the Semantic Web. The "big idea" behind semantic web was of a framework that not only described how information is shown (like headings, body etc), but also what it means, like name, address etc.
|
||||
|
||||
## Installation
|
||||
By creating a web framework that allowed for easy definition of metadata, it made building complex applications easy. Applications usually designed around how users interact with a system, but not based on semantics of the underlying system. Applications built on semantics end up being much more consistent and extensible. The first application built on Framework was ERPNext, a beast with more than 700 object types. Framework is not for the light hearted - it is not the first thing you might want to learn if you are beginning to learn web programming, but if you are ready to do real work, then Framework is the right tool for the job.
|
||||
|
||||
### Production
|
||||
* [Managed Hosting on Frappe Cloud](https://frappecloud.com/)
|
||||
* [Easy install script using Docker images](https://github.com/frappe/bench/tree/develop#easy-install-script)
|
||||
* [Manual install using Docker images](https://github.com/frappe/frappe_docker)
|
||||
### Key Features
|
||||
|
||||
### Development
|
||||
* [Easy install script using Docker images](https://github.com/frappe/bench/tree/develop#easy-install-script)
|
||||
* [Development installation on bare metal](https://frappeframework.com/docs/user/en/installation)
|
||||
- **Full-Stack Framework**: Frappe covers both front-end and back-end development, allowing developers to build complete applications using a single framework.
|
||||
|
||||
- **Built-in Admin Interface**: Provides a pre-built, customizable admin dashboard for managing application data, reducing development time and effort.
|
||||
|
||||
- **Role-Based Permissions**: Comprehensive user and role management system to control access and permissions within the application.
|
||||
|
||||
- **REST API**: Automatically generated RESTful API for all models, enabling easy integration with other systems and services.
|
||||
|
||||
- **Customizable Forms and Views**: Flexible form and view customization using server-side scripting and client-side JavaScript.
|
||||
|
||||
- **Report Builder**: Powerful reporting tool that allows users to create custom reports without writing any code.
|
||||
|
||||
<details>
|
||||
<summary>Screenshots</summary>
|
||||
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
## Production Setup
|
||||
|
||||
### Managed Hosting
|
||||
|
||||
You can try [Frappe Cloud](https://frappecloud.com), a simple, user-friendly and sophisticated [open-source](https://github.com/frappe/press) 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 an ability to manage and control multiple Frappe deployments.
|
||||
|
||||
<div>
|
||||
<a href="https://frappecloud.com/" target="_blank">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/try-on-fc-white.png">
|
||||
<img src="https://frappe.io/files/try-on-fc-black.png" alt="Try on Frappe Cloud" height="28" />
|
||||
</picture>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
### Self Hosting
|
||||
|
||||
### Docker
|
||||
Prerequisites: docker, docker-compose, git. Refer [Docker Documentation](https://docs.docker.com) for more details on Docker setup.
|
||||
|
||||
Run following commands:
|
||||
|
||||
```
|
||||
git clone https://github.com/frappe/frappe_docker
|
||||
cd frappe_docker
|
||||
docker compose -f pwd.yml up -d
|
||||
```
|
||||
|
||||
After a couple of minutes, site should be accessible on your localhost port: 8080. Use below default login credentials to access the site.
|
||||
- Username: Administrator
|
||||
- Password: admin
|
||||
|
||||
See [Frappe Docker](https://github.com/frappe/frappe_docker?tab=readme-ov-file#to-run-on-arm64-architecture-follow-this-instructions) for ARM based docker setup.
|
||||
|
||||
## Development Setup
|
||||
### Manual Install
|
||||
|
||||
The Easy Way: our install script for bench will install all dependencies (e.g. MariaDB). See https://github.com/frappe/bench for more details.
|
||||
|
||||
New passwords will be created for the Frappe "Administrator" user, the MariaDB root user, and the frappe user (the script displays the passwords and saves them to ~/frappe_passwords.txt).
|
||||
|
||||
### Local
|
||||
|
||||
To setup the repository locally follow the steps mentioned below:
|
||||
|
||||
1. Setup bench by following the [Installation Steps](https://docs.frappe.io/framework/user/en/installation) and start the server
|
||||
```
|
||||
bench start
|
||||
```
|
||||
|
||||
2. In a separate terminal window, run the following commands:
|
||||
```
|
||||
# Create a new site
|
||||
bench new-site frappe.dev
|
||||
|
||||
# Map your site to localhost
|
||||
bench --site frappe.dev add-to-hosts
|
||||
```
|
||||
|
||||
3. Open the URL `http://frappe.dev:8000/app` in your browser, you should see the app running
|
||||
|
||||
## Learning and community
|
||||
|
||||
1. [Frappe School](https://frappe.school) - Learn Frappe Framework and ERPNext from the various courses by the maintainers or from the community.
|
||||
2. [Official documentation](https://docs.frappe.io/framework) - Extensive documentation for Frappe Framework.
|
||||
3. [Discussion Forum](https://discuss.frappe.io/) - Engage with community of Frappe Framework users and service providers.
|
||||
4. [buildwithhussain.dev](https://buildwithhussain.dev) - Watch Frappe Framework being used in the wild to build world-class web apps.
|
||||
|
||||
## Contributing
|
||||
|
||||
1. [Code of Conduct](CODE_OF_CONDUCT.md)
|
||||
1. [Contribution Guidelines](https://github.com/frappe/erpnext/wiki/Contribution-Guidelines)
|
||||
1. [Security Policy](SECURITY.md)
|
||||
1. [Issue Guidelines](https://github.com/frappe/erpnext/wiki/Issue-Guidelines)
|
||||
1. [Report Security Vulnerabilities](https://frappe.io/security)
|
||||
1. [Pull Request Requirements](https://github.com/frappe/erpnext/wiki/Contribution-Guidelines)
|
||||
|
||||
## Resources
|
||||
|
||||
1. [frappeframework.com](https://frappeframework.com) - Official documentation of the Frappe Framework.
|
||||
1. [frappe.school](https://frappe.school) - Pick from the various courses by the maintainers or from the community.
|
||||
1. [buildwithhussain.dev](https://buildwithhussain.dev) - Watch Frappe Framework being used in the wild to build world-class web apps.
|
||||
|
||||
## License
|
||||
This repository has been released under the [MIT License](LICENSE).
|
||||
|
||||
By contributing to Frappe, you agree that your contributions will be licensed under its MIT License.
|
||||
<br>
|
||||
<br>
|
||||
<div align="center">
|
||||
<a href="https://frappe.io" target="_blank">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/Frappe-white.png">
|
||||
<img src="https://frappe.io/files/Frappe-black.png" alt="Frappe Technologies" height="28"/>
|
||||
</picture>
|
||||
</a>
|
||||
</div>
|
||||
Loading…
Add table
Reference in a new issue