Skip to content

Commit 8dae5b7

Browse files
📝 docs(readme): leaner readme
1 parent 63098a6 commit 8dae5b7

File tree

1 file changed

+3
-127
lines changed

1 file changed

+3
-127
lines changed

README.md

+3-127
Original file line numberDiff line numberDiff line change
@@ -26,86 +26,14 @@
2626
<a href="https://discord.gg/aV6DxwXhzN" target="_blank">Join Community</a>
2727
</div>
2828

29-
30-
<details open="open">
31-
<summary>Table of Contents</summary>
32-
33-
- [About](#about)
34-
- [Demo](#demo)
35-
- [Features Walkthrough Video](#features-walkthrough-video)
36-
- [Motivation](#motivation)
37-
- [Why you should try DashPress](#why-you-should-try-dashpress)
38-
- [Getting Started](#getting-started)
39-
- [Prerequisites](#prerequisites)
40-
- [Installation](#installation)
41-
- [Features](#features)
42-
- [Roadmap](#roadmap)
43-
- [Support](#support)
44-
- [Project assistance](#project-assistance)
45-
- [Contributing](#contributing)
46-
- [Authors & contributors](#authors--contributors)
47-
- [Security](#security)
48-
- [License](#license)
49-
- [Built With](#acknowledgements)
50-
51-
</details>
52-
5329
---
5430

5531
## About
56-
DashPress generates powerful admin apps from your database information
57-
- With just one command
58-
- Under 30 seconds
59-
- No tutorial
60-
- No learning curve
61-
- No drag and drop
62-
- No technical skills required
63-
- Zero maintenance
64-
65-
What you get is a fully functional admin app that is ready to be deployed.
66-
67-
DashPress will help you focus your engineering resources on building exciting features and not building and maintaining boring and repetitive CRUD apps.
68-
69-
### Demo
70-
https://demo.dashpress.io is an example admin app generated with DashPress without writing any line of code.
71-
72-
### Features Walkthrough Video
73-
Click on the image below to see a walkthrough of the many features DashPress provides.
74-
75-
[![Watch the video](https://img.youtube.com/vi/aO500EjHw1c/mqdefault.jpg)](https://youtu.be/aO500EjHw1c)
76-
77-
78-
### Motivation
79-
Most internal tool applications make you build from the ground up i.e you get a blank canvas, drag and drop components, and wire them together with SQL and Javascript/Python to satisfy your business requirement. This I believe has many problems.
80-
81-
- They require some technical knowledge.
82-
- They require some learning curve.
83-
- They require time to build.
84-
- You duplicate a lot of business logic already in your database.
85-
- You to maintain them.
86-
87-
DashPress attempts internal tool generation with a new approach by introspecting your database and building a multi-page application based on all the info it can find like your field types, relationships, constraints etc. You literally can have your admin app done in seconds without any tutorial or coding.
88-
89-
### Why you should try DashPress
90-
- It is free
91-
- Easiest installation, Just one command to install and run
92-
- You will always be running the latest version
93-
- The little learning curve with truly less than 5% technical knowledge requirement
94-
- Tons of features
95-
- Language/framework agnostic
96-
- Lastly, It is open source.
97-
98-
## Getting Started
99-
100-
### Prerequisites
101-
- [Node.js](https://nodejs.org/en/download/)
102-
- Supported database (MySQL, Postgres, MsSQL, SQLite)
32+
Dashpress is an admin app generator to help you transform your database schema into a sleek, customizable and performant admin dashboards quickly and efficiently.
10333

10434
### Installation
10535

10636
```bash
107-
$ cd <project_name>
108-
10937
$ npx dashpress
11038
```
11139

@@ -114,48 +42,8 @@ That is all, You will be able to see the application on http://localhost:3000.
11442
If you prefer to use Docker, Check the `Dockerfile.example` file in the root folder of the repo.
11543

11644

117-
## Features
118-
- Unlimited Users
119-
- Unlimited Roles
120-
- One Command Installation
121-
- Actions Integrations
122-
- Dashboard Builder
123-
- CRUD
124-
- Self Hosted
125-
- Form Validations
126-
- Form Logic
127-
- Breadcrumbs
128-
- Rich Text Editor
129-
- Tab Views
130-
- DB Introspection
131-
- Fields Customisation
132-
- Secure Authentication
133-
- Synced DB Validations
134-
- Secure Credentials Storage
135-
- Light And Dark Mode
136-
- Intelligent Filters
137-
- Brand Colors
138-
- Intelligent Data Relationships
139-
- Menu Builder
140-
- Themes
141-
- Personalized Table
142-
- Bookmarks
143-
- 2FA
144-
- Multiple Dashboards
145-
- Data Export
146-
- Charts
147-
- Bulk Actions
148-
- Fine-Grained Crud Permissions
149-
- Change History
150-
- Sensitive Fields
151-
152-
## Roadmap
153-
154-
See the [open issues](https://github.com/dashpresshq/dashpress/issues) for a list of proposed features (and known issues).
155-
156-
- [Top Feature Requests](https://github.com/dashpresshq/dashpress/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
157-
- [Top Bugs](https://github.com/dashpresshq/dashpress/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
158-
- [Newest Bugs](https://github.com/dashpresshq/dashpress/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
45+
### Demo
46+
https://demo.dashpress.io is an example admin app generated with DashPress without writing any line of code.
15947

16048
## Support
16149

@@ -164,22 +52,10 @@ Join the community at one of the following places:
16452
- [Twitter](https://twitter.com/dashpressHQ)
16553
- [GitHub Discussions](https://github.com/dashpresshq/dashpress/discussions)
16654

167-
168-
## Project assistance
169-
170-
If you want to say **thank you** or/and support the active development of DashPress:
171-
172-
- Add a [GitHub Star](https://github.com/dashpresshq/dashpress) to the project.
173-
- Tweet about DashPress.
174-
- Write interesting articles about DashPress on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your blog.
175-
176-
Together, we can make DashPress **better**!
177-
17855
## Contributing
17956

18057
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**.
18158

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

18561
## Security

0 commit comments

Comments
 (0)