Giter Club home page Giter Club logo

socialnetworkingservice_api's Introduction

SocialNetworkingService_API

Social Networking Service REST API Server

목차

  1. 개요
  2. How To Use
  3. Convention

1. 개요

SNS 서비스 Server REST API

  • 사용자는 서비스에 접속하여 게시물을 업로드 하거나 다른 사람의 게시물을 확인하고, 좋아요 기능을 이용할 수 있다.
  • 사용자 정보는 JWT토큰을 이용
  • 로그아웃은 프론트엔드에서 처리

ERD

1

Directory Structure

SocialNetworkingService_API
├─ bin
│  └─ www
├─ config
│  └─ index.js
├─ models
│  ├─ index.js
│  ├─ boardModel.js
│  └─ userModel.js
├─ api
│  ├─ router.js
│  ├─ board
│  │  ├─ boardController.js
│  │  ├─ boardDAO.js
│  │  └─ boardService.js
│  └─ user
│     ├─ userController.js
│     ├─ userDAO.js
│     └─ userService.js
├─ middleware
│  └─ auth.js
├─ modules
│  ├─ error.js
│  └─ jwt.js
├─ app.js
└─ README.md

Applied Technology

  • 사용언어 : Javascript
  • 런타임 환경 : Node.js
  • 프레임워크 : Express
  • 데이터베이스 : Mysql
  • ORM : Sequelize

2. How To Use

npm install
npm start

API DOCS

https://documenter.getpostman.com/view/22649152/2s83mdLjev

Preferences(.env)

PORT =

DB_HOST=
DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=

JWT_SECRETKEY=

3. Convention

Branch Convention

Main : Release 용, 완성된 버전(ex_v1.0)만 merge 됩니다.
Develop: 버전이 완성되기까지 이 브랜치를 사용합니다.
Feature: 기능별로 커밋합니다. API 도메인별로 나누어집니다.
Release: Develop 브랜치의 버전이 완성된 경우 이 브랜치에 저장합니다.
Hotfix: Release된 코드에서 버그가 발견될 경우 사용됩니다.

Commit Convention

Init : 처음 커밋 및 환경 설정
Feat : 새로운 API에 대한 기능 추가
Modify : 기존 API에 대한 기능 고도화 및 코드 수정 (버그x)
Chore : 빌드 업무 수정, 패키지 매니저 수정, 그 외 주석수정 etc.
Docs : 문서 수정
Style : 코드 포맷팅, 코드 변경이 없는 경우, linting
Test : 테스트 코드, 리팩터링 테스트 코드
Refactor : 코드 리팩터링
Fix : 버그 수정

socialnetworkingservice_api's People

Contributors

i-jdk avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.