diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..63c013f --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +(The MIT License) + +Copyright (c) 2017-2023 Kamil Mysliwiec + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +'Software'), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 636e1cb..c0f1df2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,90 @@ -# Rich + +*** 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][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] +[![LinkedIn][linkedin-shield]][linkedin-url] + + + + +
+
+ + 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. +
  2. + Getting Started + +
    3. +
  3. Usage
    4. +
  4. Roadmap
    5. +
  5. Contributing
    6. +
  6. License
    7. +
  7. Contact
    8. +
  8. Acknowledgments
    9. +
+
+ + + + + +## About The Project + +[![Product Name Screen Shot][product-screenshot]](https://example.com) +Rich Is A Nestjs System Designed To Handle Needed Requirements In usual Projects Like: -Rich Is A Nestjs System Designed To Handle Needed Requirements In Usuall Projects Like: 1. permission 2. role 3. user @@ -8,18 +92,187 @@ Rich Is A Nestjs System Designed To Handle Needed Requirements In Usuall Project 5. crud And A Lot More In Near Future! - - ## 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)

+ +### 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][Nest.js]][Nest-url] + +[//]: # (* [![React][React.js]][React-url]) + +

(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: - ## Rich Requirements -You Need To Have: 1. node 2. yarn 3. redis 4. ts-node 5. git + +### Installation + +#### Clone the project + +clone the project: + +```sh +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 + +- [x] currect the realtions in cruds +- [x] refactore services to use common service +- [x] role engine +- [x] add redis too login +- [x] add .env +- [x] add filter +- [x] add csv export +- [x] add dwonload avatar +- [x] add user status *DONE +- [x] validate permission (no match, wrong structure) +- [x] model generator (crud gnerator) +- [x] refolder +- [x] add excel too Crud Generator +- [ ] update role's permission +- [ ] notification +- [ ] socket (emqx) (for backup service) +- [ ] name the routes +- [ ] seed +- [ ] add ELASTIC +- [x] add linters +- [ ] separate configuration files +- [ ] add frontend (react+ant design) +- [ ] complete Docker +- [x] better readme +- [ ] add documentation (as wiki) + +See the [open issues](https://github.com/ialiaslani/rich/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 + +[//]: # (Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com) + +[//]: # (Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)) + +

(back to top)

+ + + + + +## Acknowledgments + +* [Choose an Open Source License](https://choosealicense.com) +* [Best README Template](https://github.com/othneildrew/Best-README-Template) + +

(back to top)

+ + + + + + +[contributors-shield]: https://img.shields.io/github/contributors/ialiaslani/rich.svg?style=for-the-badge +[contributors-url]: https://github.com/ialiaslani/rich/graphs/contributors + +[forks-shield]: https://img.shields.io/github/forks/ialiaslani/rich.svg?style=for-the-badge +[forks-url]: https://github.com/ialiaslani/rich/network/members + +[stars-shield]: https://img.shields.io/github/stars/ialiaslani/rich.svg?style=for-the-badge +[stars-url]: https://github.com/ialiaslani/rich/stargazers + +[issues-shield]: https://img.shields.io/github/issues/ialiaslani/rich.svg?style=for-the-badge +[issues-url]: https://github.com/ialiaslani/rich/issues + +[license-shield]: https://img.shields.io/github/license/ialiaslani/rich.svg?style=for-the-badge +[license-url]: https://github.com/ialiaslani/rich/LICENSE + +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/ + +[product-screenshot]: docs/assets/images/png/ + +[Nest.js]: https://img.shields.io/badge/nestjs-%23E0234E.svg?style=for-the-badge&logo=nestjs&logoColor=white +[Nest-url]: https://nestjs.com/ + +[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB +[React-url]: https://reactjs.org/ + diff --git a/Todo.md b/Todo.md deleted file mode 100644 index 7a25459..0000000 --- a/Todo.md +++ /dev/null @@ -1,25 +0,0 @@ - -#todo: - -1. - [x] currect the realtions in cruds -2. - [x] refactore services to use common service -3. - [x] role engine -4. - [x] add redis too login -5. - [x] add .env -6. - [x] add filter -7. - [x] add csv export -8. - [x] add dwonload avatar -9. - [x] add user status *DONE -10. - [x] validate permission (no match, wrong structure) -11. - [x] model generator (crud gnerator) -12. - [x] refolder -13. - [x] add excel too Crud Generator -14. - [ ] update role's permission -15. - [ ] notification -16. - [ ] socket (emqx) (for backup service) -17. - [ ] name the routes -18. - [ ] seed -19. - [ ] add ELASTIC -20. - [x] add linters -21. - [ ] separate configuration files -22. - [ ] diff --git a/docs/assets/images/png/logo-black.png b/docs/assets/images/png/logo-black.png new file mode 100644 index 0000000..5ada391 Binary files /dev/null and b/docs/assets/images/png/logo-black.png differ diff --git a/docs/assets/images/png/logo-color.png b/docs/assets/images/png/logo-color.png new file mode 100644 index 0000000..bd0a80c Binary files /dev/null and b/docs/assets/images/png/logo-color.png differ diff --git a/docs/assets/images/png/logo-no-background.png b/docs/assets/images/png/logo-no-background.png new file mode 100644 index 0000000..9e437a8 Binary files /dev/null and b/docs/assets/images/png/logo-no-background.png differ diff --git a/docs/assets/images/png/logo-white.png b/docs/assets/images/png/logo-white.png new file mode 100644 index 0000000..e6af166 Binary files /dev/null and b/docs/assets/images/png/logo-white.png differ diff --git a/docs/assets/images/svg/logo-black.svg b/docs/assets/images/svg/logo-black.svg new file mode 100644 index 0000000..bbb13bc --- /dev/null +++ b/docs/assets/images/svg/logo-black.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/images/svg/logo-color.svg b/docs/assets/images/svg/logo-color.svg new file mode 100644 index 0000000..e625d57 --- /dev/null +++ b/docs/assets/images/svg/logo-color.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/images/svg/logo-no-background.svg b/docs/assets/images/svg/logo-no-background.svg new file mode 100644 index 0000000..e2909f9 --- /dev/null +++ b/docs/assets/images/svg/logo-no-background.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/images/svg/logo-white.svg b/docs/assets/images/svg/logo-white.svg new file mode 100644 index 0000000..1dfdba8 --- /dev/null +++ b/docs/assets/images/svg/logo-white.svg @@ -0,0 +1 @@ + \ No newline at end of file