update readme for all pkgs (#9)

README.md

@@ -1,35 +1,30 @@
-# react-nestjs-monorepo
+# react-node-ts-monorepo
 
-**The ideal repository for full-stack app development with ReactJS as the frontend as NestJS fastify server as the backend**
+**The ideal repository for full-stack web development with ReactJS, NextJS as the frontend and ExpressJS, NestJS-fastify server as the backend**
 
 ## Features
 
 - [Turborepo](https://turborepo.org/)
-- [React](https://reactjs.org/) v18, [NestJs](https://nestjs.com/) v8.0.0
+- [React](https://reactjs.org/) v18, [NestJs](https://nestjs.com/) v14.1, [ExpressJS](https://expressjs.com/), [NestJS](https://nestjs.com/) v10.3
 - 100% [Typescript](https://www.typescriptlang.org/)
-- [Prettier](https://prettier.io/) setup
-- Use `@core/lib` as a shared package 
-- [Mui](https://mui.com/), [Redux](https://redux.js.org/) and [Mobx](https://mobx.js.org/README.html) preconfigured.
+- [Prettier](https://prettier.io/) and Eslint setup alongside `pre-commit` hook.
+- [Mui](https://mui.com/) and [Redux](https://redux.js.org/) preconfigured.
 - [Dockerize](https://docs.docker.com/) images
 - Easy to customise
 - Github Actions to test apps & docker images build
 
 ## Get Started
 
 Place the shared packages in the `packages` folder & the applications code in the `apps` folder.
-If you do not wish to use Turborepo, clone the `yarn-workspaces` branch of this project.  
+If you do not wish to use Turborepo, delete `turbo.json` and remove it from `devDependencies` of the package.json in the root directory.
 
 Install `node_modules`
 
 ```
 yarn
 ```
 
-Build the `@core/lib` first.
-
-```
-yarn lib:build
-```
+Add relavant scripts in the root package.json for the frontend and backend apps of your choice.
 
 Build, run, lint or test all your apps in one command thanks to [Turborepo's Pipelines](https://turborepo.org/docs/core-concepts/pipelines)
 

apps/express-server/README.md

@@ -1,3 +1,13 @@
 # express-server
 
-Express JS Application with Typescript
+Express JS Application with Typescript
+
+## Running the app
+
+```bash
+# development
+$ yarn run dev
+
+# production mode
+$ yarn run start:prod
+```

apps/frontend/README.md

@@ -10,3 +10,20 @@
 - Configured [Redux](https://redux.js.org/) store using [redux-toolkit](https://redux-toolkit.js.org/), which also takes care of api fetching
 - Github Actions for checking build status
 - Dockerfile configured
+
+
+## Running the app
+
+Build the local npm package `@core/lib` first.
+
+```
+yarn workspace @core/lib lib:build
+```
+
+```bash
+# development
+$ yarn run dev
+
+# production mode
+$ yarn run start:prod
+```

apps/nestjs-server/README.md

@@ -2,44 +2,11 @@
   <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
 </p>
 
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
-
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
-
-## Description
-
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
-
-## Installation
-
-```bash
-$ yarn install
-```
-
 ## Running the app
 
 ```bash
 # development
-$ yarn run start
-
-# watch mode
-$ yarn run start:dev
+$ yarn run dev
 
 # production mode
 $ yarn run start:prod
@@ -57,17 +24,3 @@ $ yarn run test:e2e
 # test coverage
 $ yarn run test:cov
 ```
-
-## 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).
-
-## Stay in touch
-
-- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
-
-## License
-
-Nest is [MIT licensed](LICENSE).

packages/core-lib/README.md

@@ -0,0 +1,5 @@
+# @core/lib
+
+Local npm package that is being used in `frontend` app. Make sure to build this before running its dependents. 
+
+You can also create similar packages, say for sharing UI components between multiple frontend apps or sharing types between client and server application.