sample backend

main
Peace 3 weeks ago
parent 33d4ec26f6
commit 50120c911b
  1. 56
      backend/.gitignore
  2. 4
      backend/.prettierrc
  3. 98
      backend/README.md
  4. 34
      backend/eslint.config.mjs
  5. 8
      backend/nest-cli.json
  6. 12685
      backend/package-lock.json
  7. 86
      backend/package.json
  8. 22
      backend/src/app.controller.spec.ts
  9. 12
      backend/src/app.controller.ts
  10. 32
      backend/src/app.module.ts
  11. 8
      backend/src/app.service.ts
  12. 11
      backend/src/common/api-response.dto.ts
  13. 9
      backend/src/main.ts
  14. 9
      backend/src/rand-data/rand-data-bulk-result.dto.ts
  15. 9
      backend/src/rand-data/rand-data-list-result.dto.ts
  16. 9
      backend/src/rand-data/rand-data-result.dto.ts
  17. 18
      backend/src/rand-data/rand-data.controller.spec.ts
  18. 32
      backend/src/rand-data/rand-data.controller.ts
  19. 17
      backend/src/rand-data/rand-data.entity.ts
  20. 13
      backend/src/rand-data/rand-data.module.ts
  21. 18
      backend/src/rand-data/rand-data.service.spec.ts
  22. 39
      backend/src/rand-data/rand-data.service.ts
  23. 9
      backend/src/user/user-result.dto.ts
  24. 18
      backend/src/user/user.controller.spec.ts
  25. 31
      backend/src/user/user.controller.ts
  26. 16
      backend/src/user/user.entity.ts
  27. 13
      backend/src/user/user.module.ts
  28. 18
      backend/src/user/user.service.spec.ts
  29. 20
      backend/src/user/user.service.ts
  30. 25
      backend/test/app.e2e-spec.ts
  31. 9
      backend/test/jest-e2e.json
  32. 4
      backend/tsconfig.build.json
  33. 21
      backend/tsconfig.json

56
backend/.gitignore vendored

@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build
# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
# OS
.DS_Store
# Tests
/coverage
/.nyc_output
# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace
# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# temp directory
.temp
.tmp
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

@ -0,0 +1,4 @@
{
"singleQuote": true,
"trailingComma": "all"
}

@ -0,0 +1,98 @@
<p align="center">
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
</p>
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
<p align="center">
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
</p>
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Project setup
```bash
$ npm install
```
## Compile and run the project
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Run tests
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Deployment
When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
```bash
$ npm install -g @nestjs/mau
$ mau deploy
```
With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
## Resources
Check out a few resources that may come in handy when working with NestJS:
- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
## Stay in touch
- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
## License
Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).

@ -0,0 +1,34 @@
// @ts-check
import eslint from '@eslint/js';
import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
import globals from 'globals';
import tseslint from 'typescript-eslint';
export default tseslint.config(
{
ignores: ['eslint.config.mjs'],
},
eslint.configs.recommended,
...tseslint.configs.recommendedTypeChecked,
eslintPluginPrettierRecommended,
{
languageOptions: {
globals: {
...globals.node,
...globals.jest,
},
sourceType: 'commonjs',
parserOptions: {
projectService: true,
tsconfigRootDir: import.meta.dirname,
},
},
},
{
rules: {
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-floating-promises': 'warn',
'@typescript-eslint/no-unsafe-argument': 'warn'
},
},
);

@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
}
}

File diff suppressed because it is too large Load Diff

@ -0,0 +1,86 @@
{
"name": "backend",
"version": "0.0.1",
"description": "",
"author": "",
"private": true,
"license": "UNLICENSED",
"scripts": {
"build": "nest build",
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
"start": "nest start",
"start:dev": "nest start --watch",
"start:debug": "nest start --debug --watch",
"start:prod": "node dist/main",
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
"test": "jest",
"test:watch": "jest --watch",
"test:cov": "jest --coverage",
"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
"test:e2e": "jest --config ./test/jest-e2e.json"
},
"dependencies": {
"@nestjs/common": "^11.0.1",
"@nestjs/config": "^4.0.2",
"@nestjs/core": "^11.0.1",
"@nestjs/jwt": "^11.0.0",
"@nestjs/passport": "^11.0.5",
"@nestjs/platform-express": "^11.0.1",
"@nestjs/typeorm": "^11.0.0",
"bcrypt": "^6.0.0",
"dotenv": "^17.2.0",
"express": "^5.1.0",
"mysql2": "^3.14.1",
"passport": "^0.7.0",
"passport-jwt": "^4.0.1",
"passport-local": "^1.0.0",
"reflect-metadata": "^0.2.2",
"rxjs": "^7.8.1",
"typeorm": "^0.3.25"
},
"devDependencies": {
"@eslint/eslintrc": "^3.2.0",
"@eslint/js": "^9.18.0",
"@nestjs/cli": "^11.0.0",
"@nestjs/schematics": "^11.0.0",
"@nestjs/testing": "^11.0.1",
"@swc/cli": "^0.6.0",
"@swc/core": "^1.10.7",
"@types/bcrypt": "^5.0.2",
"@types/express": "^5.0.3",
"@types/jest": "^29.5.14",
"@types/node": "^22.10.7",
"@types/supertest": "^6.0.2",
"eslint": "^9.18.0",
"eslint-config-prettier": "^10.0.1",
"eslint-plugin-prettier": "^5.2.2",
"globals": "^16.0.0",
"jest": "^29.7.0",
"prettier": "^3.4.2",
"source-map-support": "^0.5.21",
"supertest": "^7.0.0",
"ts-jest": "^29.2.5",
"ts-loader": "^9.5.2",
"ts-node": "^10.9.2",
"tsconfig-paths": "^4.2.0",
"typescript": "^5.7.3",
"typescript-eslint": "^8.20.0"
},
"jest": {
"moduleFileExtensions": [
"js",
"json",
"ts"
],
"rootDir": "src",
"testRegex": ".*\\.spec\\.ts$",
"transform": {
"^.+\\.(t|j)s$": "ts-jest"
},
"collectCoverageFrom": [
"**/*.(t|j)s"
],
"coverageDirectory": "../coverage",
"testEnvironment": "node"
}
}

@ -0,0 +1,22 @@
import { Test, TestingModule } from '@nestjs/testing';
import { AppController } from './app.controller';
import { AppService } from './app.service';
describe('AppController', () => {
let appController: AppController;
beforeEach(async () => {
const app: TestingModule = await Test.createTestingModule({
controllers: [AppController],
providers: [AppService],
}).compile();
appController = app.get<AppController>(AppController);
});
describe('root', () => {
it('should return "Hello World!"', () => {
expect(appController.getHello()).toBe('Hello World!');
});
});
});

@ -0,0 +1,12 @@
import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';
@Controller()
export class AppController {
constructor(private readonly appService: AppService) {}
@Get()
getHello(): string {
return this.appService.getHello();
}
}

@ -0,0 +1,32 @@
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { TypeOrmModule } from '@nestjs/typeorm';
import { UserModule } from './user/user.module';
import { RandDataModule } from './rand-data/rand-data.module';
@Module({
imports: [
ConfigModule.forRoot({ isGlobal: true }), // .env 불러오도록 설정
TypeOrmModule.forRootAsync({
imports: [ConfigModule],
inject: [ConfigService],
useFactory: (config: ConfigService) => ({
type: 'mysql',
host: config.get<string>('DB_HOST'),
port: parseInt(config.get<string>('DB_PORT') || '3306'),
username: config.get<string>('DB_USERNAME'),
password: config.get<string>('DB_PASSWORD'),
database: config.get<string>('DB_DATABASE'),
autoLoadEntities: true,
synchronize: true,
}),
}),
UserModule,
RandDataModule
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}

@ -0,0 +1,8 @@
import { Injectable } from '@nestjs/common';
@Injectable()
export class AppService {
getHello(): string {
return 'Hello World!';
}
}

@ -0,0 +1,11 @@
export class ApiResponseDto<T = any> {
success: boolean;
data?: T;
message?: string;
errorCode?: string | number;
constructor(success: boolean, option?: Partial<ApiResponseDto<T>>) {
this.success = success;
if (option) Object.assign(this, option);
}
}

@ -0,0 +1,9 @@
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
app.enableCors();
await app.listen(process.env.PORT ?? 3000);
}
bootstrap();

@ -0,0 +1,9 @@
export class RandDataBulkResultDto {
success: boolean;
id: number[];
constructor(ids: number[]) {
this.success = true;
this.id = ids;
}
}

@ -0,0 +1,9 @@
export class RandDataListResultDto {
success: boolean;
data: { id: number; value: number; createdAt: Date }[];
constructor(data: { id: number; value: number; createdAt: Date }[]) {
this.success = true;
this.data = data;
}
}

@ -0,0 +1,9 @@
export class RandDataResultDto {
success: boolean;
id: number;
constructor(id: number) {
this.success = true;
this.id = id;
}
}

@ -0,0 +1,18 @@
import { Test, TestingModule } from '@nestjs/testing';
import { RandDataController } from './rand-data.controller';
describe('RandDataController', () => {
let controller: RandDataController;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [RandDataController],
}).compile();
controller = module.get<RandDataController>(RandDataController);
});
it('should be defined', () => {
expect(controller).toBeDefined();
});
});

@ -0,0 +1,32 @@
import { Body, Controller, Get, Param, Post } from '@nestjs/common';
import { RandDataService } from './rand-data.service';
import { RandDataResultDto } from './rand-data-result.dto';
import { RandDataBulkResultDto as RandDataBulkResultDto } from './rand-data-bulk-result.dto';
import { RandDataListResultDto } from './rand-data-list-result.dto';
@Controller('rand-data')
export class RandDataController {
constructor(private randDataService: RandDataService) {}
@Post('generate')
async generate(@Body('userId') userId: number) {
const data = await this.randDataService.generateForUser(userId);
return new RandDataResultDto(data.id);
}
@Post('populate')
async populate(@Body('userId') userId: number, @Body('count') count: number) {
const dataList = await this.randDataService.populateForUser(userId, count);
const ids = dataList.map(d => d.id);
return new RandDataBulkResultDto(ids);
}
@Get(':userId')
async getAll(@Param('userId') userId: number) {
const dataList = await this.randDataService.getAllForUser(userId);
return new RandDataListResultDto(dataList);
}
}

@ -0,0 +1,17 @@
import { User } from "src/user/user.entity";
import { Column, Entity, ManyToMany, ManyToOne, PrimaryGeneratedColumn } from "typeorm";
@Entity()
export class RandData {
@PrimaryGeneratedColumn()
id: number;
@Column('float')
value: number;
@ManyToOne(() => User, user => user.id)
user: User;
@Column({ default: () => 'CURRENT_TIMESTAMP' })
createdAt: Date;
}

@ -0,0 +1,13 @@
import { Module } from '@nestjs/common';
import { RandDataService } from './rand-data.service';
import { RandDataController } from './rand-data.controller';
import { TypeOrmModule } from '@nestjs/typeorm';
import { RandData } from './rand-data.entity';
import { User } from 'src/user/user.entity';
@Module({
imports: [TypeOrmModule.forFeature([RandData, User])],
providers: [RandDataService],
controllers: [RandDataController]
})
export class RandDataModule {}

@ -0,0 +1,18 @@
import { Test, TestingModule } from '@nestjs/testing';
import { RandDataService } from './rand-data.service';
describe('RandDataService', () => {
let service: RandDataService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [RandDataService],
}).compile();
service = module.get<RandDataService>(RandDataService);
});
it('should be defined', () => {
expect(service).toBeDefined();
});
});

@ -0,0 +1,39 @@
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { RandData } from './rand-data.entity';
import { Repository } from 'typeorm';
import { User } from 'src/user/user.entity';
@Injectable()
export class RandDataService {
constructor(
@InjectRepository(RandData) private randDataRepository: Repository<RandData>,
@InjectRepository(User) private userRepository: Repository<User>) {}
async generateForUser(userId: number): Promise<RandData> {
const user = await this.userRepository.findOne({ where: { id: userId } });
if (!user) throw new Error('User not found');
const value = parseFloat((Math.random() * 100).toFixed(4));
const data = this.randDataRepository.create({ value, user });
return await this.randDataRepository.save(data);
}
async populateForUser(userId: number, count: number): Promise<RandData[]> {
const user = await this.userRepository.findOne({ where: { id: userId } });
if (!user) throw new Error('User not found');
const dataList: RandData[] = [];
for (let i = 0; i < count; i++) {
const value = parseFloat((Math.random() * 100).toFixed(4));
const data = this.randDataRepository.create({ value, user });
dataList.push(data);
}
return await this.randDataRepository.save(dataList);
}
async getAllForUser(userId: number): Promise<RandData[]> {
return await this.randDataRepository.find({ where: { user: { id: userId } } });
}
}

@ -0,0 +1,9 @@
export class UserResultDto {
success: boolean;
id: number;
constructor(id: number) {
this.success = true;
this.id = id;
}
}

@ -0,0 +1,18 @@
import { Test, TestingModule } from '@nestjs/testing';
import { UserController } from './user.controller';
describe('UserController', () => {
let controller: UserController;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [UserController],
}).compile();
controller = module.get<UserController>(UserController);
});
it('should be defined', () => {
expect(controller).toBeDefined();
});
});

@ -0,0 +1,31 @@
import { BadRequestException, Body, Controller, Post } from '@nestjs/common';
import { UserService } from './user.service';
import * as bcrypt from 'bcrypt';
import { UserResultDto } from './user-result.dto';
@Controller('user')
export class UserController {
constructor(private userService: UserService) {}
@Post('register')
async register(@Body('username') username: string, @Body('password') password: string)
{
const exist = await this.userService.findByUsername(username);
if (exist) throw new BadRequestException("Already existed username");
const user = await this.userService.create(username, password);
return new UserResultDto(user.id);
}
@Post('login')
async login(@Body('username') username: string, @Body('password') password: string)
{
const user = await this.userService.findByUsername(username);
if (!user) throw new BadRequestException("Login failed");
const valid = await bcrypt.compare(password, user.password);
if (!valid) throw new BadRequestException("Login failed");
return new UserResultDto(user.id);
}
}

@ -0,0 +1,16 @@
import { Column, Entity, PrimaryGeneratedColumn } from "typeorm";
@Entity()
export class User {
@PrimaryGeneratedColumn()
id: number;
@Column({ unique: true })
username: string;
@Column()
password: string;
@Column({ default: () => 'CURRENT_TIMESTAMP' })
createdAt: Date;
}

@ -0,0 +1,13 @@
import { Module } from '@nestjs/common';
import { UserService } from './user.service';
import { UserController } from './user.controller';
import { TypeOrmModule } from '@nestjs/typeorm';
import { User } from './user.entity';
@Module({
imports: [TypeOrmModule.forFeature([User])],
providers: [UserService],
controllers: [UserController],
exports: [UserService]
})
export class UserModule {}

@ -0,0 +1,18 @@
import { Test, TestingModule } from '@nestjs/testing';
import { UserService } from './user.service';
describe('UserService', () => {
let service: UserService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [UserService],
}).compile();
service = module.get<UserService>(UserService);
});
it('should be defined', () => {
expect(service).toBeDefined();
});
});

@ -0,0 +1,20 @@
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { User } from './user.entity';
import * as bcrypt from 'bcrypt';
@Injectable()
export class UserService {
constructor(@InjectRepository(User) private userRepository: Repository<User>) {}
async create(username: string, password: string): Promise<User> {
const hashed = await bcrypt.hash(password, 10);
const user = this.userRepository.create({ username, password: hashed });
return await this.userRepository.save(user);
}
async findByUsername(username: string): Promise<User | null> {
return await this.userRepository.findOne({ where: { username }});
}
}

@ -0,0 +1,25 @@
import { Test, TestingModule } from '@nestjs/testing';
import { INestApplication } from '@nestjs/common';
import * as request from 'supertest';
import { App } from 'supertest/types';
import { AppModule } from './../src/app.module';
describe('AppController (e2e)', () => {
let app: INestApplication<App>;
beforeEach(async () => {
const moduleFixture: TestingModule = await Test.createTestingModule({
imports: [AppModule],
}).compile();
app = moduleFixture.createNestApplication();
await app.init();
});
it('/ (GET)', () => {
return request(app.getHttpServer())
.get('/')
.expect(200)
.expect('Hello World!');
});
});

@ -0,0 +1,9 @@
{
"moduleFileExtensions": ["js", "json", "ts"],
"rootDir": ".",
"testEnvironment": "node",
"testRegex": ".e2e-spec.ts$",
"transform": {
"^.+\\.(t|j)s$": "ts-jest"
}
}

@ -0,0 +1,4 @@
{
"extends": "./tsconfig.json",
"exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
}

@ -0,0 +1,21 @@
{
"compilerOptions": {
"module": "commonjs",
"declaration": true,
"removeComments": true,
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"allowSyntheticDefaultImports": true,
"target": "ES2023",
"sourceMap": true,
"outDir": "./dist",
"baseUrl": "./",
"incremental": true,
"skipLibCheck": true,
"strictNullChecks": true,
"forceConsistentCasingInFileNames": true,
"noImplicitAny": false,
"strictBindCallApply": false,
"noFallthroughCasesInSwitch": false
}
}
Loading…
Cancel
Save