Skip to content

Commit a458c0a

Browse files
authored
update readme for all pkgs (#9)
1 parent 73cc76a commit a458c0a

File tree

5 files changed

+41
-61
lines changed

5 files changed

+41
-61
lines changed

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,30 @@
1-
# react-nestjs-monorepo
1+
# react-node-ts-monorepo
22

3-
**The ideal repository for full-stack app development with ReactJS as the frontend as NestJS fastify server as the backend**
3+
**The ideal repository for full-stack web development with ReactJS, NextJS as the frontend and ExpressJS, NestJS-fastify server as the backend**
44

55
## Features
66

77
- [Turborepo](https://turborepo.org/)
8-
- [React](https://reactjs.org/) v18, [NestJs](https://nestjs.com/) v8.0.0
8+
- [React](https://reactjs.org/) v18, [NestJs](https://nestjs.com/) v14.1, [ExpressJS](https://expressjs.com/), [NestJS](https://nestjs.com/) v10.3
99
- 100% [Typescript](https://www.typescriptlang.org/)
10-
- [Prettier](https://prettier.io/) setup
11-
- Use `@core/lib` as a shared package
12-
- [Mui](https://mui.com/), [Redux](https://redux.js.org/) and [Mobx](https://mobx.js.org/README.html) preconfigured.
10+
- [Prettier](https://prettier.io/) and Eslint setup alongside `pre-commit` hook.
11+
- [Mui](https://mui.com/) and [Redux](https://redux.js.org/) preconfigured.
1312
- [Dockerize](https://docs.docker.com/) images
1413
- Easy to customise
1514
- Github Actions to test apps & docker images build
1615

1716
## Get Started
1817

1918
Place the shared packages in the `packages` folder & the applications code in the `apps` folder.
20-
If you do not wish to use Turborepo, clone the `yarn-workspaces` branch of this project.
19+
If you do not wish to use Turborepo, delete `turbo.json` and remove it from `devDependencies` of the package.json in the root directory.
2120

2221
Install `node_modules`
2322

2423
```
2524
yarn
2625
```
2726

28-
Build the `@core/lib` first.
29-
30-
```
31-
yarn lib:build
32-
```
27+
Add relavant scripts in the root package.json for the frontend and backend apps of your choice.
3328

3429
Build, run, lint or test all your apps in one command thanks to [Turborepo's Pipelines](https://turborepo.org/docs/core-concepts/pipelines)
3530

apps/express-server/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
11
# express-server
22

3-
Express JS Application with Typescript
3+
Express JS Application with Typescript
4+
5+
## Running the app
6+
7+
```bash
8+
# development
9+
$ yarn run dev
10+
11+
# production mode
12+
$ yarn run start:prod
13+
```

apps/frontend/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,20 @@
1010
- Configured [Redux](https://redux.js.org/) store using [redux-toolkit](https://redux-toolkit.js.org/), which also takes care of api fetching
1111
- Github Actions for checking build status
1212
- Dockerfile configured
13+
14+
15+
## Running the app
16+
17+
Build the local npm package `@core/lib` first.
18+
19+
```
20+
yarn workspace @core/lib lib:build
21+
```
22+
23+
```bash
24+
# development
25+
$ yarn run dev
26+
27+
# production mode
28+
$ yarn run start:prod
29+
```

apps/nestjs-server/README.md

Lines changed: 1 addition & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,11 @@
22
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
33
</p>
44

5-
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
6-
[circleci-url]: https://circleci.com/gh/nestjs/nest
7-
8-
<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>
9-
<p align="center">
10-
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
11-
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
12-
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
13-
<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>
14-
<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>
15-
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
16-
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
17-
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
18-
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
19-
<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>
20-
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
21-
</p>
22-
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
23-
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
24-
25-
## Description
26-
27-
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
28-
29-
## Installation
30-
31-
```bash
32-
$ yarn install
33-
```
34-
355
## Running the app
366

377
```bash
388
# development
39-
$ yarn run start
40-
41-
# watch mode
42-
$ yarn run start:dev
9+
$ yarn run dev
4310

4411
# production mode
4512
$ yarn run start:prod
@@ -57,17 +24,3 @@ $ yarn run test:e2e
5724
# test coverage
5825
$ yarn run test:cov
5926
```
60-
61-
## Support
62-
63-
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).
64-
65-
## Stay in touch
66-
67-
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
68-
- Website - [https://nestjs.com](https://nestjs.com/)
69-
- Twitter - [@nestframework](https://twitter.com/nestframework)
70-
71-
## License
72-
73-
Nest is [MIT licensed](LICENSE).

packages/core-lib/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# @core/lib
2+
3+
Local npm package that is being used in `frontend` app. Make sure to build this before running its dependents.
4+
5+
You can also create similar packages, say for sharing UI components between multiple frontend apps or sharing types between client and server application.

0 commit comments

Comments
 (0)