Skip to content

Commit 9feff1a

Browse files
docs: add readme
1 parent d812f7e commit 9feff1a

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AdminBro Addon template
2+
3+
This an AdminBro addon template repository. You may use it if you want to create
4+
5+
* AdminBro plugin
6+
* AdminBro adapter
7+
* AdminBro feature
8+
9+
## What is inside
10+
11+
It is a typescript repository with:
12+
13+
* TypeScript
14+
* linter with semantic commits (ensures the same style across AdminBro packages)
15+
* semantic-release
16+
* github actions
17+
* example application with cypress
18+
19+
What is missing:
20+
* cypress run in the CI which is an optional. You can take a look at admin-bro/core repository to see how to build it.
21+
22+
## How to use it
23+
24+
In order to start working on an AdminBro feature/plugin/adapter follow this steps:
25+
26+
1. fork this repository
27+
2.

0 commit comments

Comments
 (0)