Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theomer77/project-template
My personal full stack project template.
https://github.com/theomer77/project-template
boilerplate docker docker-compose hono honojs nginx nginx-docker node nodejs pnpm pnpm-workspace project-template react reactjs template typescript
Last synced: about 2 months ago
JSON representation
My personal full stack project template.
- Host: GitHub
- URL: https://github.com/theomer77/project-template
- Owner: TheOmer77
- License: mit
- Created: 2022-12-10T20:42:08.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T16:14:21.000Z (3 months ago)
- Last Synced: 2024-10-04T22:11:17.218Z (3 months ago)
- Topics: boilerplate, docker, docker-compose, hono, honojs, nginx, nginx-docker, node, nodejs, pnpm, pnpm-workspace, project-template, react, reactjs, template, typescript
- Language: TypeScript
- Homepage:
- Size: 1.34 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project Template
This is my personal project template, used for building full stack applications.
## About this template
### Included apps and packages
- `@repo/frontend`: A [React](https://react.dev) [Next.js](https://nextjs.org/) app.
- `@repo/backend`: A [Node.js](https://nodejs.org) server, powered by [Hono](https://hono.dev/).
- `@repo/shared`: A package for shared code between apps.
- `@repo/eslint-config`: ESLint presets used by other apps.
- `@repo/tsconfig`: Base tsconfig.json files used by other apps.
- A package builder service, responsible for automatically rebuilding shared packages on changes (in development only).
All apps and packages are built using [TypeScript](https://www.typescriptlang.org/).
### Docker
This project uses Docker and Docker Compose to build and run all apps. Additional services & environment variables can be added in `compose.yaml` for production, and `compose.dev.yaml` for development.
### Utilities
- [PNPM](https://pnpm.io/) as the package manager
- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
Installing the relevant VSCode extensions is recommended.
## Run the project
### Prerequisites
- [Docker](https://www.docker.com/)
In development, you'll also need:
- [Node.js](https://nodejs.org/) 20
- [PNPM](https://pnpm.io/)
### Running the services
Run the project using Docker Compose:
```bash
docker compose up -d
```
The frontend app will be available at [localhost:3000](http://localhost:3000), and the backend will be accessible from [localhost:3000/api](http://localhost:3000/api).
### Local development
Install dependencies using PNPM:
```bash
pnpm install
```
Use Docker Compose to run the project, making sure you use the development compose file:
```bash
docker compose -f compose.dev.yaml up -d
```
Then just open your web browser to access the frontend at [localhost:3000](http://localhost:3000) and the backend at [localhost:3000/api](http://localhost:3000/api), just like in production.
Any changes you make to the frontend during development will automatically be reflected in the browser, while any changes made to the backend code will cause the development server to restart. Both services will react to changes made to shared packages.
## Configuration
### Updating environment variables
Environment variables for the entire project are stored in the `.env` file. After editing this file:
- If any new variables were added, add them to the relevant services in `compose.yaml` (or `compose.dev.yaml` in development):
```yml
frontend:
environment:
- ENV_VAR=${ENV_VAR}
backend:
environment:
- ENV_VAR=${ENV_VAR}
```
- Recreate the relevant services (use the correct compose file):
```bash
docker compose up -d --force-recreate
```
### Installing & updating dependencies
To install dependencies in an app or package, run:
```bash
pnpm -F @repo/ i
```
To install dependencies at the workspace root (usually dev dependencies), replace `-F @repo/` with `-w`.
After dependency updates, rebuild the relevant services. If you installed dependencies in a package, rebuild all apps that use it & the package builder.
```bash
docker compose up -d --build
```