This is a starter project for a full-stack application using Turborepo.
The following applications are included:
Web (Next.js) | Description | Support |
---|---|---|
ServerComponent | Rendering on the server | ✅ |
ClientComponent | Client on the server | ✅ |
ServerAction | New ability to omit redundant HTTP methods | ✅ |
AppRoute | Latest routing methods | ✅ |
TailwindCSS | CSS Library | ✅ |
Embedded CSS | Embed CSS in the head tag to maximize performance | ✅ |
ReduxStore | State controlled library | ✅ |
PWA | Functions to be enabled on the terminal | 🚫 |
API (Nest.js) | Description | Support |
---|---|---|
Multiple databases | Connect to multiple Mongodb databases | ✅ |
REST | API that follows REST design principles | ✅ |
DiscordBot | Discord App Use Cases | 🚫 |
Packages | Description |
---|---|
critters | A plugin to inline critical CSS and lazy-load the rest |
esbuild | An extremely fast JavaScript bundler and minifier |
eslint | A tool for identifying and reporting on patterns in JavaScript |
jest | A delightful JavaScript testing framework |
prettier | An opinionated code formatter |
tailwind | A utility-first CSS framework for rapid UI development |
tsconfig | Shared TypeScript configurations |
ui | A collection of reusable UI components |
npm install --global yarn
npm install --global nps
You can install it any way you like.
You can install it any way you like.
gcloud auth login
- Develop Mode
nps prepare.api && nps dev
- Production Mode
Warning
Run it in a separate terminal.
nps start.web
nps start.api
-
Production environment
-
Merging requires Pull Request.
-
Merging requires confirmation of operation in a stage environment.
-
Frequent rebasing of the main branch for consistency.
-
Confirm that the pull request works in the stage environment before submitting it.
-
If the environment cannot be checked locally, deploy manually to the develop environment to check the operation.
The following is incorporated
The recommended commit method is yarn commit
or npm run commit
.
You can create commits interactively
Commit | Description |
---|---|
Commitizen | Standard for consistent commitments |
Commitlint | Inspect for commitments according to the rules |
husky | Automatically inspect when git commit is run |
- Edit
name
in package.json
Warning
Please respect GoogleCloudRun's naming conventions.
Only -
special symbols are allowed and names exceeding 32 characters cannot be set.
Prefixes are handled internally in the system and must be set to 20 characters.
-
Copy .env.example to
.env
and fill in the values -
Run Scripts
Note
Please grant the authority to execute shell scripts in advance!
yarn setup-google-cloud
- Install act
brew install act
- Copy .variables.example to
.variables
and fill in the values
Note
The values in this file are called out in vars.xxx
!
- Copy .env.example to
.env
and fill in the values
Note
The values in this file are called out in secrets.xxx
!
- Run test
yarn act --job=job_name
Note
Run act:list
to see the list of jobs