-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
57 changed files
with
2,068 additions
and
1,171 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,42 @@ | ||
| # Backpex | ||
| <img src="https://github.com/naymspace/backpex/blob/develop/priv/static/images/logo.svg" width="100" height="100"> | ||
|
|
||
| [](https://github.com/naymspace/backpex/actions/workflows/ci.yml) | ||
| [](https://github.com/naymspace/backpex/blob/develop/LICENSE.md) | ||
| [](https://hex.pm/packages/backpex) | ||
| [](https://hexdocs.pm/backpex) | ||
|
|
||
| Backpex is a simple admin dashboard that makes it easy to manage existing resources in your application. | ||
|
|
||
| See our comprehensive [docs](https://hexdocs.pm/backpex) for more information. | ||
| # Backpex | ||
|
|
||
| ## Screenshot ([Live Demo](https://backpex.live/admin/users)) | ||
| Welcome! Backpex is a highly customizable administration panel for Phoenix LiveView applications. Quickly create beautiful CRUD views for your existing data using configurable *LiveResources*. Backpex integrates seamlessly with your existing Phoenix application and provides a simple way to manage your resources. It is highly customizable and can be extended with your own layouts, views, field types, filters and more. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## Development | ||
| <div align="center"> | ||
| <a href="https://backpex.live/"><strong>Visit our Live Demo →</strong></a> | ||
| </div> | ||
|
|
||
| ### Requirements | ||
| ## Key Features | ||
|
|
||
| - [Docker](https://www.docker.com/) | ||
| - **LiveResources**: Quickly create LiveResource modules for your database tables with fully customizable CRUD views. Bring your own layout or use our components. | ||
| - **Search and Filters**: Define searchable fields on your resources and add custom filters. Get instant results with the power of Phoenix LiveView. | ||
| - **Resource Actions**: Add your globally available custom actions (like user invitation or exports) with additional form fields to your LiveResources. | ||
| - **Authorization**: Handle authorization for all your CRUD and custom actions via simple pattern matching. Optionally integrate your own authorization library. | ||
| - **Field Types**: Many field types (e.g. Text, Number, Date, Upload) are supported out of the box. Easily create your own field type modules with custom logic. | ||
| - **Associations**: Handle HasOne, BelongsTo and HasMany(Through) associations with minimal configuration. Customize available options and rendered columns. | ||
| - **Metrics**: Easily add value metrics (like sums or averages) to your resources for a quick glance at your date. More metric types are in the making. | ||
|
|
||
| ### Recommended Extensions | ||
| ## Installation & Documentation | ||
|
|
||
| - [Editorconfig](http://editorconfig.org) | ||
| - [JavaScript Standard Style](https://github.com/standard/standard#are-there-text-editor-plugins) | ||
| See our comprehensive [installation guide](guides/get_started/installation.md) for more information on how to install and configure Backpex in your Phoenix application. | ||
|
|
||
| ### Setup | ||
| We also provide a detailed [documentation](https://hexdocs.pm/backpex) with guides on how to use Backpex and how to customize it to your needs. | ||
|
|
||
| - Clone the repository. | ||
| - In `demo` directory run `cp .env.example .env` and set values accordingly. | ||
| - Generate `SECRET_KEY_BASE` via `mix phx.gen.secret`. | ||
| - Generate `LIVE_VIEW_SIGNING_SALT` via `mix phx.gen.secret 32`. | ||
| - Run `docker compose up` (`yarn watch` is triggered automatically). | ||
| ## Learn More | ||
|
|
||
| Now you can visit [`localhost:4000`](http://localhost:4000) from your browser. | ||
| - [What is Backpex?](guides/about_backpex/what-is-backpex.md) | ||
| - [Why we built Backpex?](guides/about_backpex/why-we-built-backpex.md) | ||
| - [Contribute to Backpex](guides/about_backpex/contribute-to-backpex.md) | ||
|
|
||
| ## License | ||
|
|
||
| Backpex source code is licensed under the [MIT License](LICENSE.md). | ||
| Backpex source code is licensed under the [MIT License](https://github.com/naymspace/backpex/blob/main/LICENSE.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # Contribute to Backpex | ||
|
|
||
| We are excited to have you contribute to Backpex! We are always looking for ways to improve the project and welcome any contributions in the form of bug reports, feature requests, documentation improvements, code contributions, and more. | ||
|
|
||
| ## What can I contribute? | ||
|
|
||
| We are in the process of writing a roadmap to outline the features we plan to implement in the future. In the meantime, you can contribute to Backpex by: | ||
|
|
||
| - Reporting bugs | ||
| - Requesting new features | ||
| - Improving the documentation | ||
| - Improving the demo application | ||
| - Fixing bugs | ||
|
|
||
| ## Fork the repository | ||
|
|
||
| In order to contribute to Backpex, you need to fork the repository. You can do this by clicking the "Fork" button in the top right corner of the repository page at [https://github.com/naymspace/backpex](https://github.com/naymspace/backpex). | ||
|
|
||
| ## Clone the repository | ||
|
|
||
| After forking the repository, you need to clone it to your local machine. You can do this by running the `git clone` command along with the URL of your forked repository. | ||
|
|
||
| ## Setting up your development environment | ||
|
|
||
| You first need to create a `.env` file in the `demo` directory of the project with the following content: | ||
|
|
||
| ```bash | ||
| SECRET_KEY_BASE=<SECRET_KEY_BASE> | ||
| LIVE_VIEW_SIGNING_SALT=<LIVE_VIEW_SIGNING_SALT> | ||
| ``` | ||
|
|
||
| For development purposes you can copy the values from the `demo/.env.example` file. | ||
|
|
||
| You can then start the development environment by running the following command in the root directory of the project: | ||
|
|
||
| ```bash | ||
| docker compose up | ||
| ``` | ||
|
|
||
| Backpex comes with a demo application that you can use to test the features of the project. The command will start a PostgreSQL database and the demo application on [http://localhost:4000](http://localhost:4000). | ||
|
|
||
| To insert some demo data into the database, you can run the following command: | ||
|
|
||
| ```bash | ||
| docker compose exec app mix ecto.seed | ||
| ``` | ||
|
|
||
| ## Making changes | ||
|
|
||
| After setting up your development environment, you can start making changes to the project. We recommend creating a new branch for your changes. After submitting your changes to your forked repository, you can create a pull request to the `develop` branch of the main repository. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # What is Backpex? | ||
|
|
||
| Backpex is a highly customizable administration panel for Phoenix LiveView applications. It allows you to quickly create CRUD views of your existing data using configurable *LiveResources*. Backpex integrates seamlessly with your existing Phoenix LiveView application and provides an easy way to manage your resources. It is highly customizable and can be extended with your own layouts, views, field types, filters and more. | ||
|
|
||
| Backpex is built on top of Phoenix LiveView and provides a rich set of features to manage your resources. With Backpex, you can set up an administration panel for your application in minutes, not hours. | ||
|
|
||
| Whether you want to quickly scaffold CRUD views for your existing data or build a full-fledged administration panel, Backpex has you covered. | ||
|
|
||
| TODO: add screenshots of key features here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Why we built Backpex? | ||
|
|
||
| After building several Phoenix applications, we realized that we were repeating ourselves when it came to building administration panels. We were writing the same CRUD views, search and filter functionality over and over again. We wanted a tool that would allow us to quickly scaffold these views and focus on building the core functionality of our applications. | ||
|
|
||
| The tool we wanted had to be able to serve as a simple backend administration panel in one project, while being the core of the application in another. | ||
|
|
||
| We looked at existing solutions, but found that none of them offered the flexibility and customization we were looking for. We decided to develop Backpex to solve this problem and provide a highly customizable administration panel for Phoenix LiveView applications. |
Oops, something went wrong.