{"id":31131834,"url":"https://github.com/bnbong/project-pinned","last_synced_at":"2025-09-18T04:40:00.316Z","repository":{"id":175795161,"uuid":"654483602","full_name":"bnbong/Project-Pinned","owner":"bnbong","description":"\u003c공모전 출품용\u003e 지역 랜드마크와 관련된 내 추억을 공유하는 지도 기반 웹 SNS 서비스","archived":false,"fork":false,"pushed_at":"2023-09-27T14:10:34.000Z","size":5752,"stargazers_count":6,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-09T21:32:41.447Z","etag":null,"topics":["django","docker","docker-compose","javascript","js","jwt","nextjs","python","react","reactjs","rest-api","restful-api","tailwindcss"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bnbong.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-06-16T08:21:43.000Z","updated_at":"2023-09-28T03:33:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"d4f4c5ea-de9f-4074-a00d-f442aeef9eff","html_url":"https://github.com/bnbong/Project-Pinned","commit_stats":null,"previous_names":["bnbong/project-pinned"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/bnbong/Project-Pinned","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bnbong%2FProject-Pinned","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bnbong%2FProject-Pinned/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bnbong%2FProject-Pinned/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bnbong%2FProject-Pinned/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bnbong","download_url":"https://codeload.github.com/bnbong/Project-Pinned/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bnbong%2FProject-Pinned/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275711219,"owners_count":25514200,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-18T02:00:09.552Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","docker","docker-compose","javascript","js","jwt","nextjs","python","react","reactjs","rest-api","restful-api","tailwindcss"],"created_at":"2025-09-18T04:39:54.990Z","updated_at":"2025-09-18T04:40:00.309Z","avatar_url":"https://github.com/bnbong.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 핀드 - 내 추억 속의 랜드마크\n\u0026lt;공모전 출품용\u003e 지역 랜드마크와 관련된 내 추억을 공유하는 지도 기반 웹 SNS 서비스\n\nSNS Link(Disabled): [Link](https://mypinnedlandmark.bnbong.tk/)\n\n## Developers  \n1. 이준혁 (팀장, 백엔드, 프로젝트 설계 및 디자인, 스프린트 매니징, 아키텍처 설계)\n2. 박종윤 (백엔드, API 테스트)\n3. 최수용 (프론트엔드, UI/UX 디자인 및 구현)\n4. 허재원 (프론트엔드, UI/UX 디자인 및 구현)\n\n# About App\n\n## 1. Stack\n* Framework: Backend - Django, Python / Frontend - Next.js, tailwind.css\n* DB: PostgreSQL\n* Cache DB: Redis\n* Proxy: Nginx\n* Container: Docker\n\n## 2. Directory Tree\n```\n├── .github (sources of github templates)\n├── project_pinned (backend sources)\n│   ├── project_pinned (sources)\n│   │   └── source files ...\n│   ├── Dockerfile (백엔드 앱 컨테이너 빌드 파일)\n│   ├── manage.py\n│   ├── setup.cfg (linter or test env configurations)\n│   ├── setup.py (configurations)\n│   ├── serviceAccountKey.json (개발자 각자 반드시 개인적으로 받아야 하는 파일)\n│   ├── requirements.txt (백엔드 프로젝트 의존성 파일)\n│   └── .env (개발자 각자 반드시 개인적으로 받아야 하는 파일)\n│\n├── nginx (proxy service)\n│\n├── front (frontend sources)\n│   ├── components\n│   │   └── source files ...\n│   ├── contexts\n│   │   └── source files ...\n│   ├── HOC\n│   │   └── source files ...\n│   ├── hook\n│   │   └── source files ...\n│   ├── pages\n│   │   └── source files ...\n│   ├── public\n│   │   └── source files ...\n│   ├── styles\n│   │   └── source files ...\n│   ├── utils\n│   │   └── source files ...\n│   ├── .babelrc\n│   ├── .dockerignore\n│   ├── .env (개발자 각자 반드시 개인적으로 받아야 하는 파일)\n│   ├── .eslintrc.json\n│   ├── .gitignore\n│   ├── Dockerfile (프론트 앱 컨테이너 빌드 파일)\n│   ├── jsonconfig.json\n│   ├── next,config.js\n│   ├── package.json\n│   ├── package-lock.json\n│   ├── postcss.config.js (framework config file)\n│   ├── tailwind.config.js (framework config file)\n│   └── README.md\n├── .env (개발자 각자 반드시 개인적으로 받아야 하는 파일)\n├── .gitignore\n├── docker-compose.yml (build containers for development)\n├── docker-compose.test.yml (build containers for before deployment, check availability)\n├── docker-compose.prod.yml (build containers for production)\n├── scripts\n│   ├── apitest.sh (API test script - backend)\n│   ├── build_dev.sh (build script for development)\n│   ├── build_test.sh (build script for before deployment, check availability)\n│   └── build_prod.sh (build script for production)\n└── README.md\n```\n\n## 3. API Docs\nAPI endpoint에 대한 설명이 기재되어 있습니다: \n - [Swagger Link](https://mypinnedlandmark.bnbong.tk/api/swagger)\n - [Github wiki Link](https://github.com/bnbong/Project-Pinned/wiki/API-documentation)\n\n## 4. DB Schemas\nPostgreSQL Database에 구현된 Table에 대한 schema가 정의되어 있습니다: [Link](https://github.com/bnbong/Project-Pinned/wiki/DB-Schemas)\n\n## 5. UI/UX Diagrams\n프론트 뷰에 구현된 UI/UX 다이어그램이 정의되어 있습니다(업로드 예정): [Link](https://github.com/bnbong/Project-Pinned/wiki/UI-UX-Diagram)\n\n# Contribution Guide\n\n## 필수 환경\n - Python 3.10.10 버전 이상 혹은 해당 버전의 Python\n - Git\n - Docker\n\n## 개발 환경 구성\n\n1. 현재 github repository를 작업할 Local 디렉토리에 clone: `git clone git@github.com:bnbong/Project-Pinned.git`\n2. 디렉토리에 python 가상 환경을 구성: `python -m venv pinn-venv`\n3. python 가상 환경으로 접속: \n   - Mac / Linux: `source pinn-venv/bin/activate`\n   - Window: `.pinn-venv/Scripts/activate`\n4. 의존성 설치: `pip install -r requirements.txt`\n5. IDE가 venv 속 python과 linter로 pylint를 사용하도록 변경: `depends on your IDE environment.`\n6. 공유받은 .env 파일을 프로젝트 디렉토리에 저장: `없다면 팀장에게 개인 연락 혹은 메일하기 (bbbong9@gmail.com)`\n7. 정의된 컨테이너들을 빌드: `bash scripts/build_dev.sh`\n8. 프론트 앱을 빌드: `cd front \u0026 npm install \u0026 npm run build \u0026 npm run dev`\n9. 컨테이너들이 정상적으로 빌드가 되었는지 확인.\n10. localhost 환경에서 개발하기, 이때 프론트 앱은 `localhost:3000`에서 확인 가능(**브라우저의 CORS 기능을 꺼준 상태에서 개발하기**).\n11. 개발이 완료되면 컨테이너들을 종료: `bash scripts/stop_dev.sh`\n12. 파이썬 가상환경을 종료: `deactivate`\n\n## Contribution Guide\n코딩 컨벤션, 커밋 메시지 작성 방법, branch 전략, document contribution 방법이 기재되어 있습니다: [Link](https://github.com/bnbong/Project-Pinned/wiki/Contribution-Guide)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbnbong%2Fproject-pinned","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbnbong%2Fproject-pinned","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbnbong%2Fproject-pinned/lists"}