Skip to content
Snippets Groups Projects
README.md 1.89 KiB
Newer Older
  • Learn to ignore specific revisions
  • Maxim Filippov's avatar
    Maxim Filippov committed
    # Pleroma AdminFE
    
    花裤衩's avatar
    花裤衩 committed
    
    
    Maxim Filippov's avatar
    Maxim Filippov committed
    ![screenshot](./public/index.png)
    
    花裤衩's avatar
    花裤衩 committed
    
    
    Maxim Filippov's avatar
    Maxim Filippov committed
    ## About
    
    花裤衩's avatar
    花裤衩 committed
    
    
    Maxim Filippov's avatar
    Maxim Filippov committed
    Admin UI for pleroma instance owners
    
    花裤衩's avatar
    花裤衩 committed
    
    
    ## Usage
    
    ### Development
    
    To run AdminFE locally execute `yarn dev`
    
    ### Build
    
    To compile everything for production run `yarn build:prod`.
    
    #### Disabling features
    
    
    Maxim Filippov's avatar
    Maxim Filippov committed
    You can disable certain AdminFE features, like reports or settings by modifying `config/prod.env.js` env variable `DISABLED_FEATURES`, e.g. if you want to compile AdminFE without "Settings" you'll need to set it to: `DISABLED_FEATURES: '["settings"]'`.
    
    Pan's avatar
    Pan committed
    ## Changelog
    
    Pan's avatar
    Pan committed
    
    
    Maxim Filippov's avatar
    Maxim Filippov committed
    Detailed changes for each release are documented in the [CHANGELOG](./CHANGELOG.md).
    
    花裤衩's avatar
    花裤衩 committed
    
    
    Pan's avatar
    Pan committed
    ## Browsers support
    
    Modern browsers and Internet Explorer 10+.
    
    | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
    | --------- | --------- | --------- | --------- |
    | IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions
    
    
    花裤衩's avatar
    花裤衩 committed
    ## License
    
    
    Maxim Filippov's avatar
    Maxim Filippov committed
    Pleroma AdminFE is build on top of the [Vue Element Admin](https://github.com/PanJiaChen/vue-element-admin), which is licensed under [MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE) license.
    
    花裤衩's avatar
    花裤衩 committed
    
    
    Maxim Filippov's avatar
    Maxim Filippov committed
    AdminFE's own code is licensed under [AGPL](./AGPL-3)