# Forest Admin in Django
[comment]: <> ([![pypi package](https://badge.fury.io/py/django-forest.svg)](https://badge.fury.io/py/django-forest))
[![CI status](https://github.com/ForestAdmin/django-forest/actions/workflows/build.yml/badge.svg)](https://github.com/ForestAdmin/django-forest/actions)
[![Test Coverage](https://api.codeclimate.com/v1/badges/1776407183b89bcc8910/test_coverage)](https://codeclimate.com/github/ForestAdmin/django-forest/test_coverage)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
## Build
`python setup.py sdist`
## Lint
### Install flake8
`pip install flake8`
### Lint files
`flake8 .`
## Test
### Run test database image
`docker-compose up -d`
### Launch tests suite
`pytest`
## Coverage
`coverage run -m pytest`
You can see coverage, thanks to `coverage report`, `coverage xml`, `coverage html`.
It is also possible to combine several coverage reports run with different python versions:
```
coverage3.6 run --parallel-mode -m pytest
coverage3.9 run --parallel-mode -m pytest
coverage combine
coverage report
```
## In a nutshell
Forest Admin provides an off-the-shelf administration panel based on a highly-extensible API plugged into your application.
This project has been designed with scalability in mind to fit requirements from small projects to mature companies.
## Who Uses Forest Admin
- [Apartmentlist](https://www.apartmentlist.com)
- [Carbon Health](https://carbonhealth.com)
- [Ebanx](https://www.ebanx.com)
- [First circle](https://www.firstcircle.ph)
- [Forest Admin](https://www.forestadmin.com) of course :-)
- [Heetch](https://www.heetch.com)
- [Lunchr](https://www.lunchr.co)
- [Pillow](https://www.pillow.com)
- [Qonto](https://www.qonto.eu)
- [Shadow](https://shadow.tech)
- And hundreds moreâ¦
## Getting Started
[https://docs.forestadmin.com/documentation/getting-started/installation](https://docs.forestadmin.com/documentation/getting-started/installation)
## Documentation
[https://docs.forestadmin.com/documentation/](https://docs.forestadmin.com/documentation/)
## How it works
<p align="center" style="margin: 60px 0">
<img width="100%" src="https://forest-assets.s3.amazonaws.com/Github+README+assets/howitworks.png" alt="Howitworks">
</p>
Forest Admin consists of two components:
- The Admin Frontend is the user interface where you'll manage your data and configuration.
- The Admin Backend API hosted on your servers where you can find and extend your data models and all the business logic (routes, actions, â¦) related to your admin panel.
The Forest Admin gem (aka Forest Liana) introspects all your data model
and dynamically generates the Admin API hosted on your servers. The Forest Admin
interface is a web application that handles communication between the admin
user and your application data through the Admin API.
## Features
### CRUD
All of your CRUD operations are natively supported. The API automatically
supports your data models' validation and allows you to easily extend or
override any API routes' with your very own custom logic.
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/crud.jpeg" alt="CRUD">
### Search & Filters
Forest Admin has a built-in search allowing you to run basic queries to
retrieve your application's data. Set advanced filters based on fields and
relationships to handle complex search use cases.
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/search+filters.jpeg" alt="Search and Filters">
### Sorting & Pagination
Sorting and pagination features are natively handled by the Admin API. We're
continuously optimizing how queries are run in order to display results faster
and reduce the load of your servers.
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/sorting+pagination.jpeg" alt="Sorting and Pagination">
### Custom action
A custom action is a button which allows you to trigger an API call to execute
a custom logic. With virtually no limitations, you can extend the way you
manipulate data and trigger actions (e.g. refund a customer, apply a coupon,
ban a user, etc.)
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/custom+actions.jpeg" alt="Custom action">
### Export
Sometimes you need to export your data to a good old fashioned CSV. Yes, we
know this can come in handy sometimes :-)
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/exports.jpeg" alt="Export">
### Segments
Get in app access to a subset of your application data by doing a basic search
or typing an SQL query or implementing an API route.
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/segments.jpeg" alt="Segments">
### Dashboards
Forest Admin is able to tap into your actual data to chart out your metrics
using a simple UI panel, a SQL query or a custom API call.
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/dashboards.jpeg" alt="Dashboard">
### WYSIWYG
The WYSIWYG interface saves you a tremendous amount of frontend development
time using drag'n'drop as well as advanced widgets to build customizable views.
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/wysiwyg.jpeg" alt="WYSIWYG">
### Custom HTML/JS/CSS
Code your own views using JS, HTML, and CSS to display your application data in
a more appropriate way (e.g. Kanban, Map, Calendar, Gallery, etc.).
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/smart+views.jpeg" alt="Custom views">
### Team-based permissions
Without any lines of code, manage directly from the UI who has access or can
act on which data using a team-based permission system.
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/teams.jpeg" alt="Team based permissions">
### Third-party integrations
Leverage data from third-party services by reconciling it with your
applicationâs data and providing it directly to your Admin Panel. All your
actions can be performed at the same place, bringing additional intelligence to
your Admin Panel and ensuring consistency.
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/integrations.jpeg" alt="Third-party integrations">
### Notes & Comments
Assign your teammates to specific tasks, leave a note or simply comment a
record, thereby simplifying collaboration all across your organization.
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/notes+comments.jpeg" alt="Notes and Comments">
### Activity logs
Monitor each action executed and follow the trail of modification on any data
with an extensive activity log system.
<img src="https://forest-assets.s3.amazonaws.com/Github+README+assets/activity+logs.jpeg" alt="Activity logs">
## How to contribute
This repository is officially maintained by Forest Admin.
We're always happy to get contributions for other fellow lumberjacks.
All contributions will be reviewed by Forest Admin's team before being merged into main.
Here is the contribution workflow:
1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull request** so that we can review your changes
Please ensure that the **tests** are passing before submitting any pull request:
```
$ docker-compose up -d
$ pytest
```
## Community
ð Join our Developers community for support and more
[![Discourse developers community](https://img.shields.io/discourse/posts?label=discourse&server=https%3A%2F%2Fcommunity.forestadmin.com)](https://community.forestadmin.com)
没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
收起资源包目录
PyPI 官网下载 | django-forestadmin-1.0.1.tar.gz (185个子文件)
setup.cfg 1KB
MANIFEST.in 34B
LICENCE 34KB
README.md 8KB
PKG-INFO 9KB
PKG-INFO 9KB
schema.py 86KB
test_permissions.py 27KB
test_stats_with_parameters.py 21KB
test_list_search.py 21KB
test_list_filters_date.py 19KB
test_detail.py 19KB
test_list_filters.py 17KB
test_list.py 16KB
test_callback.py 15KB
test_list.py 15KB
test_schema.py 14KB
test_collection.py 12KB
test_json_api_schema.py 11KB
test_list_smart_fields.py 10KB
test_list_scope.py 9KB
test_live_queries.py 9KB
__init__.py 8KB
test_ip_whitelist.py 8KB
test_list_sort.py 7KB
json_api_schema.py 7KB
utils.py 5KB
test_csv.py 5KB
test_list_smart_relationship.py 5KB
callback.py 5KB
search.py 5KB
0001_initial.py 5KB
test_change.py 5KB
question.py 4KB
test_load.py 4KB
collection.py 4KB
test_forest_api_requester.py 4KB
test_list_smart_segment.py 4KB
__init__.py 4KB
settings.py 4KB
utils.py 4KB
test_csv.py 4KB
test_index.py 4KB
test_dynamic_client_registrator.py 4KB
test_count.py 3KB
__init__.py 3KB
test_client_manager.py 3KB
list.py 3KB
models.py 3KB
json_api_serializer.py 3KB
detail.py 3KB
permissions.py 3KB
forest_api_requester.py 3KB
test_count.py 3KB
utils.py 3KB
scope.py 3KB
base.py 3KB
test_configuration_retriever.py 2KB
test_scope_cache_invalidation.py 2KB
validations.py 2KB
ip_whitelist.py 2KB
list.py 2KB
type_mapping.py 2KB
smart_field.py 2KB
index.py 2KB
__init__.py 2KB
__init__.py 2KB
decorators.py 2KB
utils.py 2KB
__init__.py 2KB
format.py 2KB
utils.py 2KB
error_handler.py 2KB
csv.py 2KB
test_cors.py 2KB
stats.py 2KB
__init__.py 2KB
client_manager.py 2KB
action.py 1KB
csv.py 1KB
csv.py 1KB
ip_whitelist.py 1KB
test_get_forest_setting.py 1KB
__init__.py 1KB
cors.py 1KB
utils.py 1KB
definitions.py 1KB
models.py 960B
limit_fields.py 939B
association.py 881B
dynamic_client_registrator.py 777B
scope_cache_invalidation.py 770B
0006_auto_20210806_2254.py 758B
0003_auto_20210701_1508.py 758B
resource.py 751B
generate_invoice.py 747B
urls.py 735B
test_utils.py 715B
apimap_errors.py 657B
0002_auto_20210615_0942.py 646B
共 185 条
- 1
- 2
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功