From 4a0a3a50c76249a6d47fcc98696511d1281f0fa7 Mon Sep 17 00:00:00 2001 From: Supan Adit Pratama Date: Tue, 29 Oct 2024 02:09:35 +0700 Subject: [PATCH] chore: update readme --- README.md | 99 ++++++++----------------------------------------------- 1 file changed, 13 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index 089595f..2ab9c6b 100644 --- a/README.md +++ b/README.md @@ -7,107 +7,34 @@

A progressive Node.js framework for building efficient and scalable server-side applications.

-NPM Version -Package License -NPM Downloads -CircleCI -Coverage -Discord -Backers on Open Collective -Sponsors on Open Collective - Donate us - Support us - Follow us on Twitter -

- + +## Status + +This project is still in development and not ready for production, it's not even ready to install yet. Calling for contributors to help this project. ## Description -[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. +Nest Auto CRUD is a library that provides a set of modules, decorator, service, and many more to reduce the boilerplate code. -## Todo +## Roadmap -- [] Create custom generic for Prisma ORM Support [#5273](https://github.com/prisma/prisma/issues/5273) +- Create custom generic for Prisma ORM Support [#5273](https://github.com/prisma/prisma/issues/5273) -## Project setup +## Installation ```bash -$ npm install +$ npm install @aditama-labs/nest-autocrud ``` -## Compile and run the project - -```bash -# development -$ npm run start - -# watch mode -$ npm run start:dev - -# build package -$ npm run build:lib:autocrud -``` - -## Generate new library - -```bash -# 1. Generate new libs -$ nest g lib -# 2. Modify the generated library tsconfig.lib.json like existing one -# 3. Add the build tools to the package.json following the existing one -# 4. Register dist to index.js -``` - -## Run tests - -```bash -# unit tests -$ npm run test - -# e2e tests -$ npm run test:e2e - -# test coverage -$ npm run test:cov -``` - -## Deployment - -When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information. - -If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps: - -```bash -$ npm install -g mau -$ mau deploy -``` - -With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure. - -## Resources - -Check out a few resources that may come in handy when working with NestJS: - -- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework. -- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy). -- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/). -- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks. -- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com). -- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com). -- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs). -- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com). - ## Support -Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). +Nest AutoCRUD is an MIT-licensed open source project. ## Stay in touch -- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec) -- Website - [https://nestjs.com](https://nestjs.com/) -- Twitter - [@nestframework](https://twitter.com/nestframework) +- Author - [Supan Adit Pratama](mailto:email@supanadit.com) +- Website - [https://supanadit.com](https://supanadit.com/) ## License -Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE). +Nest AutoCRUD is MIT licensed