Skip to content

Latest commit

 

History

History
278 lines (185 loc) · 7.63 KB

README.md

File metadata and controls

278 lines (185 loc) · 7.63 KB
Raw

*** Thanks for checking out the Rich. If you have a suggestion *** that would make this better, please fork the repo and create a pull request *** or simply open an issue with the tag "enhancement". *** Don't forget to give the project a star! *** Thanks again! Now go create something AMAZING! :D -->

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Rich

An awesome README template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot Rich Is A Nestjs System Designed To Handle Needed Requirements In usual Projects Like:

  1. permission
  2. role
  3. user
  4. request log
  5. crud

And A Lot More In Near Future!

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Nest

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

You Need these dependencies:

  1. node
  2. yarn
  3. redis
  4. ts-node
  5. git

Installation

Clone the project

clone the project:

git clone https://github.com/ialiaslani/rich.git

(back to top)

Usage

Rich Command Line:

You Can Add A New Crud In Your App With Handled Swagger, Permission, Crud, Dtos And etc Just With Using: yarn rich crud test And Alos There Is A -p Flag If You Want Your Routes To Be Public!

Rich Crud

Rich Crud Suports Dynamic Query On Entity, Export Excel, Load Relations And Permissions Too!

(back to top)

Roadmap

  • currect the realtions in cruds
  • refactore services to use common service
  • role engine
  • add redis too login
  • add .env
  • add filter
  • add csv export
  • add dwonload avatar
  • add user status *DONE
  • validate permission (no match, wrong structure)
  • model generator (crud gnerator)
  • refolder
  • add excel too Crud Generator
  • update role's permission
  • notification
  • socket (emqx) (for backup service)
  • name the routes
  • seed
  • add ELASTIC
  • add linters
  • separate configuration files
  • add frontend (react+ant design)
  • complete Docker
  • better readme
  • add documentation (as wiki)

See the open issues for a full list of proposed features (and known issues) .

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

(back to top)

Acknowledgments

(back to top)