dashpresshq/dashpress

<h1 align="center">
  <a href="https://github.com/dashpresshq/dashpress">
    <img src="https://dashpress.io/assets/banner/1.png" alt="Logo" >
  </a>
</h1>

<div align="center">

[![Project license](https://img.shields.io/github/license/dashpresshq/dashpress.svg)](LICENSE)
[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-23bc42.svg)](https://github.com/dashpresshq/dashpress/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
<img src="https://img.shields.io/npm/v/dashpress" />
<img src="https://img.shields.io/github/languages/top/dashpresshq/dashpress" />


[![Maintainability](https://api.codeclimate.com/v1/badges/23516bfbcca7557d80a5/maintainability)](https://codeclimate.com/github/dashpresshq/dashpress/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/23516bfbcca7557d80a5/test_coverage)](https://codeclimate.com/github/dashpresshq/dashpress/test_coverage)
<img src="https://img.shields.io/codeclimate/tech-debt/dashpresshq/dashpress" />
![GitHub CI](https://github.com/dashpresshq/dashpress/actions/workflows/release.yml/badge.svg)


</div>

<div align="center">
  <a href="https://demo.dashpress.io" target="_blank">Live Demo</a>
  ·
  <a href="https://discord.gg/aV6DxwXhzN" target="_blank">Join Community</a>
</div>

---

## About
Dashpress is an admin app generator to help you transform your database schema into a sleek, customizable and performant admin dashboards quickly and efficiently.

### Installation

```bash
$ npx dashpress
```

That is all, You will be able to see the application on http://localhost:3000.

If you prefer to use Docker, Check the `Dockerfile.example` file in the root folder of the repo.


### Demo
https://demo.dashpress.io is an example admin app generated with DashPress without writing any line of code.

## Support

Join the community at one of the following places:
- [Discord](https://discord.gg/aV6DxwXhzN)
- [Twitter](https://twitter.com/dashpressHQ)
- [GitHub Discussions](https://github.com/dashpresshq/dashpress/discussions)

## Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.

Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you for being involved!

## Security

DashPress takes security at heart and follows all known good practices of security, but 100% security cannot be assured.
DashPress is provided **"as is"** without any **warranty**.

_For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._

## License

This project is licensed under the **GNU Affero General Public License v3.0**.

See [LICENSE](LICENSE) for more information.