Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mazgi/template.containerized-nextjs-project
A template repository for developing Web Frontend and API powered by TypeScript & Docker :whale:
https://github.com/mazgi/template.containerized-nextjs-project
dockerize graphql nestjs nextjs openapi template-repository typescript
Last synced: about 16 hours ago
JSON representation
A template repository for developing Web Frontend and API powered by TypeScript & Docker :whale:
- Host: GitHub
- URL: https://github.com/mazgi/template.containerized-nextjs-project
- Owner: mazgi
- License: mit
- Created: 2020-09-14T19:00:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-20T01:21:43.000Z (over 1 year ago)
- Last Synced: 2024-05-02T00:20:47.428Z (7 months ago)
- Topics: dockerize, graphql, nestjs, nextjs, openapi, template-repository, typescript
- Language: TypeScript
- Homepage:
- Size: 5.21 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# template.containerized-nextjs-project
[](https://github.com/mazgi/template.containerized-nextjs-project/actions/workflows/unit-tests.yml)
[](https://github.com/mazgi/template.containerized-nextjs-project/actions/workflows/e2e-tests.yml)
[](https://github.com/mazgi/template.containerized-nextjs-project/actions/workflows/build-production-images.yml)
This repository is a template for developing Web Applications using [Next.js](https://nextjs.org/) and TypeScript.
## How to Use
Docker and [Docker Compose](https://docs.docker.com/compose/) are needed. If you want to develop and run locally, that's all.
### Step 1: Write out your IDs and information in the .env file
If you have an old `.env` file, you are able to reset it by removing it.
```console
rm -f .env
```
```.env
UID=1234
GID=1234
DOCKER_GID=2345
BIND_IP_ADDR=192.168.0.1
PUBLIC_IP_ADDR_OR_FQDN=203.0.113.1
```
:open_file_folder: Expand details for the .env file and environment variables...
:information_source: If you are using Linux, write out UID, GID, and GID for the `docker` group, into the `.env` file to let that as exported on Docker Compose as environment variables.
```console
test $(uname -s) = 'Linux' && {
echo -e "DOCKER_GID=$(getent group docker | cut -d : -f 3)"
echo -e "GID=$(id -g)"
echo -e "UID=$(id -u)"
} >> .env || :
```
:information_source: If you develop in a remote environment such as VM, Cloud, a PC placed in another room, and others, write the IP address and FQDN into the `.env` file, such as `BIND_IP_ADDR` and `PUBLIC_IP_ADDR_OR_FQDN`, the same as the previous steps.
Though you don't need to define these values if you are developing and running locally and connecting locally to local.
```console
cat<> .env
BIND_IP_ADDR=192.168.0.1
PUBLIC_IP_ADDR_OR_FQDN=203.0.113.1
EOE
```
The `BIND_IP_ADDR` is used to bind your services, such as web applications you are developing, RDBMS, and others. And `PUBLIC_IP_ADDR_OR_FQDN` is used to connect and identify your services, such as Web API endpoints, allowed origins for CORS settings, and others.
In almost all situations, the BIND_IP_ADDR is your local IP address, and you are able to get this value via CLI and GUI such as `ip addr show`, `ifconfig`, `ipconfig`, and others.
Typically, the `BIND_IP_ADDR` and `PUBLIC_IP_ADDR_OR_FQDN` are the same if you use a VM in your local and other regular situations.
However, if you are developing in an environment under NAT, you should get your public IP address or FQDN and set this value as PUBLIC_IP_ADDR_OR_FQDN.
This situation can happen if you develop on a Cloud VM such as Amazon EC2, Azure VM, Google Compute Engine(GCE), etc.
#### Environment Variable Names
Environment variable names and uses are as follows.
| Name | Required on Linux | Value |
| ---------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| DOCKER_GID | **Yes** | This ID number is used to provide permission to read and write your docker socket on your local machine from your container. |
| GID | **Yes** | This ID number is used as GID for your Docker user, so this ID becomes the owner of all files and directories created by the container. |
| UID | **Yes** | The same as the above UID. |
| Name | Value |
| ---------------------- | ---------------------------------------------------------------- |
| BIND_IP_ADDR | It's used to bind your services. |
| PUBLIC_IP_ADDR_OR_FQDN | It's used by the Frontend to connect the BFF you are developing. |
### Step 2: Start services via Docker Compose
You start Docker Compose services/containers as below.
```console
docker compose up
```
Now you can access your services at the following ports.
- Frontend: `http://${PUBLIC_IP_ADDR_OR_FQDN}:3000`
- BFF: `http://${PUBLIC_IP_ADDR_OR_FQDN}:4000`
- GraphQL Playground: `http://${PUBLIC_IP_ADDR_OR_FQDN}:4000/graphql`
- OpenAPI Web UI: `http://${PUBLIC_IP_ADDR_OR_FQDN}:4000/swagger`
- Storybook: `http://${PUBLIC_IP_ADDR_OR_FQDN}:6006`
:open_file_folder: Expand additional operations for starting, testing, and more...
You are able to start services in the background as below.
```console
docker compose up --wait
```
And you can start following logs for specific the service/container as below.
If you want to stop following logs, type `^c`.
```console
docker compose logs --follow --no-log-prefix bff
```
```console
docker compose logs --follow --no-log-prefix frontend
```
You run tests as below.
```console
docker compose exec bff npm run test
```
```console
docker compose exec frontend npm run test
```
If you want to run tests in the "watch" mode, you are able to start services to do it.
```console
docker compose --profile dev-all up
```
Or if you `up` any service to "watch" mode, it implicitly enabling the profile `dev-all`.
```console
docker compose up bff-test-watch
```
```console
docker compose up frontend-test-watch
```
The following official documents help you understand the behavior on this page.
- https://docs.docker.com/compose/profiles/
- https://docs.docker.com/compose/extends/
And you are able to stop services as below.
```console
docker compose down
```