반응형

슬기로운 개발자생활 55

코딩 스타일 가이드

코딩 스타일 가이드는 2인 이상이라면 규모에 상관없이 정하고간다. 2인 팀의 소규모 프로젝트부터 기업과 같이 인원수가 많은 곳 어디든 스타일 가이드는 코드리뷰와 유지보수를 위해 중요하다. 주로 컨벤션이라고 함 스타일가이드 스타일 가이드의 기본적인 의미는 프로젝트를 시작할 때 최종 제품의 시각적 이미지 및 표현을 정의하고 디자인 및 개발 프로세스를 계획하는 데 사용하기 위한 것이다. 코딩 스타일 가이드는 코드의 표현을 정의하는 것이라고 볼 수 있다. 순서 1. 개발 언어 별 변수, 함수, 클래스 네이밍 규칙 2. git flow 3. IT 기업 스타일 가이드 4. 참고자료 1. 개발 언어 별 변수, 함수, 클래스 네이밍 규칙 파이썬 (Python) # variable snake_case = True # c..

Linux기반 OS (Ubuntu) 터미널 명령어 정리

기본적으로 Ubuntu나 Linux서버는 AWS에서 빌려서 사용하는 경우가 많고, 주된 사용 목적은 웹서버, crontab으로 돌리는 파이썬 프로그램이다. CLI (Command Line Interface) 명령어 인터페이스 = 터미널 순서 1. 경로 2. 파일 관리 3. vim editor 1. 경로 pwd : 현재 위치를 출력 cd : 경로 변경 ls : 현재 경로에 있는 파일, 경로목록 출력 ls -a : 숨김폴더까지 모두 출력 ls -l : 권한, 상세정보 출력 ls -al 2. 파일관리 mkdir : 폴더 생성 cp : 파일 복사 (잘 사용안하고 파이썬 파일로 코딩해서 씀) mv : 파일 이동 (마찬가지) rm : 삭제 (디렉토리 삭제 시 -r 옵션, -f 시 즉시 삭제) touch : 파일 생..

심플 API 디자인패턴

아직은 부족한 실력이지만, 백엔드 서버 개발을 하면서 찾아보고 알게 된 API 작성법에 대한 글을 남겨보고 나도 이 글을 통해 원칙을 세워보자 한다. API (Application Programming Interface) API는 간단하게 특정 비즈니스 로직을 서버에서 처리하고 그 결과를 네트워크 통신을 통해 전달하는 메커니즘이다. 최근에는 클라가 서버 데이터에 액세스하는 REST API가 메인이고 이 글도 REST API를 다룬다. 순서 1. API 원칙 2. REST API 샘플 3. Router 규칙 4. 문서화 5. 참고자료 1. API 원칙 당연스럽게도 하나의 API는 하나의 일만 '잘' 해야한다. 에러가 발생할 수 있는 사항은 가능한 빨리 확인, 처리한다. 클라이언트에서 예외처리를 요구하는 리..

Git 기초 개념과 활용

개인프로젝트를 진행할 때나, 팀단위 프로젝트를 진행할 때 git을 주로 사용한다. 팀으로 협업을 할 때에는 코드 컨벤션뿐 아니라 git 컨벤션을 필수적으로 정하는 것을 보면 깃을 통한 협업은 개발쪽에서 필수가 되었다. Git 컴퓨터파일의 변경사항을 추적하고 여러 사용자들 간의 작업 조율을 위한 분산 버전 관리 시스템, 인터넷 연결 없이도 동작하는 독립적인 이력관리, 버전추적 등 기능을 갖춘 저장소 순서 Git 기본 개념 git 기본 명령어 git 설정 git 협업 명령어 1. Git 기본 개념 저장소 : .git 폴더가 있는, git으로 관리되고 있는 폴더 로컬저장소 : 내 컴퓨터에 저장 원격저장소 : github, gitlab등 웹 서버에 저장 커밋 : 변경사항을 기록하여 하나의 버전으로 상태를 저장 ..

Screen 백그라운드에서 가상 터미널로 프로그램 실행하기 [Linux, Ubuntu]

가끔은 cron을 통한 잡 스케줄러보다, 특정 프로그램을 서버에서 계속해서 실행해야 하는 경우가 있다. 클라우드 서버에서 접속하면 생성되는 터미널은 기본적으로 접속을 끊는 순간 종료되기 때문에, 백그라운드에서 돌아가고 언제든 꺼내볼 수 있는 가상 터미널을 생성하는 screen 명령어가 굉장히 유용하다. Screen Linux기반 OS에서 독립적으로 동작하는 가상 터미널을 생성하는 소프트웨어 위키백과에서는 여러 가상 콘솔을 다중화하는데 쓰이는 응용 소프트웨어이자 터미널 다중화기라고 정의하고있다. 순서 1. 스크린 생성 2. 스크린 빠져나오기 3. 스크린 재접속 4. 스크린 확인 5. 스크린 종료 1. 스크린 생성 vscode 환경에서 접속했다 가정 screen options -S [스크린 이름] : 해당 ..

NCP 서버 접속 (in VS Code)

사이드 프로젝트를 진행하면서, 네이버 클라우드 플랫폼(NCP) 30만원 크레딧을 제공받는 김에 AWS 대신 NCP를 써보기로 했다. AWS EC2서버에 접속하는것과는 조금 다르고, 관련 레퍼런스도 많지 않아 설정하는데 조금 애먹었다. 설정하면서 느낀점은 디테일한 부분을 꼼꼼히 신경쓰는 네이버답게 보안이 잘 되어있다는 것과 내가 내 서버 접속하는것도 까다로운데 내 서버가 과연 해킹당할 수 있을까? 라는 생각도 들었다. 순서 1. 준비사항 2. VSCode Extension 설치 3. config 파일 수정 4. Trouble Shooting 1. 준비사항 NCP 서버 로그인 후 콘솔에 접속하면 좌측 메뉴바를 확인할 수 있다. 여기서 Region과 Platform에 따라 서버가 나뉜다. (생성한 서버가 안 ..

AWS EC2 서버 접속 (in VS Code)

가상의 컴퓨터를 하나 빌리는 것은 다양한 작업(자동화 프로그램, 간단한 FE, BE 배포)을 하는데 유용하다. CLI에서 접속해서 사용하는것보단 vscode같은 IDE툴을 활용하는 것이 생산성이 더 좋다고 생각한다. 서버 다양한 목적(컴퓨팅, DB, AI, ...)을 위해 컴퓨팅 자원을 구축하거나(자체서버) 빌려 사용(클라우드)하여 제공되는 것 순서 1. 준비사항 2. VSCode Extension 설치 3. config 파일 수정 4. Trouble Shooting 1. 준비사항 AWS EC2 EC2 서버는 생성시 기본적으로 보안 그룹에 ssh 접속을 위한 22번포트가 열려있음 ★★★★★ 키페어 파일인 pem 파일을 잘 관리할 것 pem파일을 주로 C:/Users/{USER_NAME}/aws 하위에 저..

Docker, Jenkins 활용 CI/CD 구축 (React, Kotlin+Spring) 3편 - 웹서버에 배포

Jenkins와 Github를 연동하여 푸시이벤트가 발생했을 시, Jenkins에서 빌드를 진행하는 것까지 설정을 해놓았으니, 이제 빌드 후에 일어날 작업들을 설정해두면 자동배포 설정이 끝난다. 한 편 을 더 추가해야 할 것 같지만.. 2022년 마지막날에 끝내고 싶어서 다 합쳐버렸다. 뒤의 과정이 상당히 긺으로 천천히 따라오실 것을 추천.. 순서 0. 전체 흐름 1. publish over ssh 2. react 빌드 후 파일 전송 3. Docker in Jenkins 4. spring 도커 빌드 후 도커 push 5. docker-compose로 백엔드 배포 6. Trouble Shotting nginx 설정 0. 전체 흐름 이번 프로젝트에서 구축한 CI/CD의 아키텍처 1. publish over ..

Docker, Jenkins 활용 CI/CD 구축 (React, Kotlin+Spring) 2편 - Jenkins Github 연동

저번 Jenkins 서버 설정까지 진행하고 나서, 본격적으로 배포를 위한 셋팅을 해야한다. 순서 0. 전체 흐름 1. github 토큰 생성 2. Jenkins에 github 토큰 등록 3. 자동배포를 진행할 레포 등록 4. Push Event Webhook 설정 5. Trouble Shotting 0. 전체 흐름 이번 프로젝트에서 구축한 CI/CD의 아키텍처 1. github 토큰 생성 깃허브에서 우측 상단 프로필을 눌러 Settings로 들어오고, 왼쪽 메뉴 하단에 있는 Developer settings에 들어온다. Personal access tokens에서 Tokens를 클릭하고 Generate new token을 클릭한다. 계정 단위 권한을 가진 것이 classic 이고, 레포단위로 권한을 줄 ..

Docker, Jenkins 활용 CI/CD 구축 (React, Kotlin+Spring) 1편 - Jenkins 서버 설정

SSAFY 프로젝트 진행 중 인프라를 구축하는것에 진심인 친구가 Jenkins, Docker를 활용해 자동배포 시스템을 구축한 것을 보고 CI/CD에 관심이 생겼다. CI/CD는 내용이 많기 때문에 3편 정도로 나누어서 진행할 예정이고, Jenkins pipeline를 활용하면 설정이 편해지지만, 각각의 구성요소를 확인해보기 위해 직접 한땀한땀 구현할 것이다. CI/CD Continuous Integration(CI) and Continuous Deployment(CD)를 통칭해 이르는 말로 지속적인 통합(소스코드 빌드/테스트 자동화)과 지속적인 배포(무중단 서비스 제공)을 의미한다. 순서 0. 전체 흐름 1. 준비사항 2. Docker, Jenkins 설치 3. Jenkins 설정 4. Trouble ..

반응형