https://github.com/kir-dev/sprint-review-app
https://github.com/kir-dev/sprint-review-app
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kir-dev/sprint-review-app
- Owner: kir-dev
- Created: 2024-05-05T17:27:56.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T18:45:10.000Z (over 1 year ago)
- Last Synced: 2024-11-21T19:35:08.198Z (over 1 year ago)
- Language: TypeScript
- Size: 684 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NestJS + NextJS Starter Project by Kir-Dev
This is a starter project for a fullstack application using NestJS and NextJS.
It includes a basic setup for a NestJS as backend and a NextJS as frontend,
including shadcn/ui, ESLint, Prettier, and GitHub Actions.
## Getting Started
### Prerequisites
- Node.js 20
- Yarn 1.22
### Installation
You only need to install dependencies in the root directory.
```bash
yarn install
```
### Linter and Formatter Configuration
It is a must to use ESLint and Prettier in this project.
Set up ESLint and Prettier in your IDE and check `fix on save` or `format on save` options.
You can run the following commands to check linting and formatting issues.
```bash
yarn lint
# or
yarn lint:fix
```
```bash
yarn format:check
# or
yarn format
```
### Development
#### Backend
Make sure to copy `.env.example` in the backend folder and name the new file `.env`.
After that, we should apply our database schema to the database itself, so run:
```bash
yarn setup:db:dev
```
#### Local start
You can run the backend and frontend separately.
```bash
yarn start:backend # Starts on http://localhost:3001
```
```bash
yarn start:frontend # Starts on http://localhost:3000
```
### After Development
You can build the frontend and run the application.
```bash
yarn build:frontend
```
Or build the backend.
```bash
yarn build:backend
```
There are recommended GitHub Actions workflows for this setup, which will fail if one of the following commands fails:
```bash
yarn lint
```
```bash
yarn format:check
```
```bash
yarn build:backend
```
### If you don't have Postgres installed, but have Docker
Run this command to spin up a container with Postgres. The `.env` file is already modified to have the appropriate connection URL.
```bash
docker volume create sprintreview_db_folder
docker-compose up --build -d
```
Now you can start the dev backend with `yarn start:backend`.
## Happy Coding!