Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nxpm/stack
🥠nxpm-stack lets you generate a complete and opinionated full-stack application in a Nx Workspace, ready to extend and deploy!
https://github.com/nxpm/stack
angular docker full-stack generators graphql nestjs nx-workspace prisma schematics stack
Last synced: 3 days ago
JSON representation
🥠nxpm-stack lets you generate a complete and opinionated full-stack application in a Nx Workspace, ready to extend and deploy!
- Host: GitHub
- URL: https://github.com/nxpm/stack
- Owner: nxpm
- License: mit
- Created: 2020-09-24T02:40:04.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-13T23:20:24.000Z (over 2 years ago)
- Last Synced: 2024-10-28T13:10:46.211Z (16 days ago)
- Topics: angular, docker, full-stack, generators, graphql, nestjs, nx-workspace, prisma, schematics, stack
- Language: TypeScript
- Homepage: https://npm.im/@nxpm/stack
- Size: 2.39 MB
- Stars: 108
- Watchers: 6
- Forks: 14
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# @nxpm/stack
## Introduction
`@nxpm/stack` is a set of schematics that generates an opinionated full-stack application in a Nx Workspace based on the PANNG Stack (Prisma, Angular, Nest, Nx, GraphQL).
## Creating a new project
### Using @nxpm/cli
You can create a new workspace by installing the @nxpm/cli package globally.
Run the following command:
```shell script
yarn global add @nxpm/cli
```
After the installation, you should have the `nxpm-stack` command available.
Run the following command to create a project called 'sandbox':
```shell script
nxpm-stack init --name sandbox
cd sandbox
```
### Manual installation
Alternatively, you can create a project manually:
Create a new Nx Workspace and make sure to use the `empty` preset.
```shell script
yarn create nx-workspace sandbox --preset=empty --nx-cloud true --cli=angular
cd sandbox
```
Install the dependencies:
```shell script
yarn add -D @nxpm/stack @nrwl/angular @nrwl/nest
```
Initialize a new project (where web is the name of the Angular frontend):
```shell script
nx g @nxpm/stack:init web
```
## Running the project
Before you can run the stack, there are some things you need to do.
### Starting the Docker server
The stack is configured to connect to a Postgres server on `localhost:5432` with a database called `prisma`, username `prisma` and password `prisma`.
There is a `docker-compose.yml` in the project root which provides this.
To start the server, run the following command:
```shell script
docker-compose up
```
### Seed the database
When starting with an empty database, you need to make sure the table structure gets created.
To do this, run the following command:
```shell script
yarn setup
```
### Start the API app
You can now start the API by running the following command:
```shell script
yarn dev:api
```
You should be able to navigate to [http://localhost:3000/graphql](http://localhost:3000/graphql) and see the GraphQL Playground.
### Generate the SDK
Once the API is up and running, we want to make sure we can generate the SDK that is being used by the frontend.
Run the following command to generate the SDK:
```shell script
yarn sdk:web
```
### Start the Web app
With this all done, you can now start the Web by running the following command:
```shell script
yarn dev:web
```
You should be able to navigate to [http://localhost:4200](http://localhost:4200) and see the Angular app.