{"id":23640844,"url":"https://github.com/modern-agile-team/create-dev-portfolio","last_synced_at":"2025-08-31T17:32:11.798Z","repository":{"id":59018814,"uuid":"532127301","full_name":"modern-agile-team/create-dev-portfolio","owner":"modern-agile-team","description":"create-dev-portfolio is a boiler-plate application developed using the dev-portfolio library","archived":false,"fork":false,"pushed_at":"2022-10-28T09:36:27.000Z","size":2583,"stargazers_count":30,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2023-05-07T12:38:27.713Z","etag":null,"topics":["dev-portfolio","docker-compose","npx","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/modern-agile-team.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-03T01:46:48.000Z","updated_at":"2023-04-27T02:20:38.000Z","dependencies_parsed_at":"2023-01-20T19:04:17.680Z","dependency_job_id":null,"html_url":"https://github.com/modern-agile-team/create-dev-portfolio","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modern-agile-team%2Fcreate-dev-portfolio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modern-agile-team%2Fcreate-dev-portfolio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modern-agile-team%2Fcreate-dev-portfolio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modern-agile-team%2Fcreate-dev-portfolio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/modern-agile-team","download_url":"https://codeload.github.com/modern-agile-team/create-dev-portfolio/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231610645,"owners_count":18400207,"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","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":["dev-portfolio","docker-compose","npx","typescript"],"created_at":"2024-12-28T09:52:27.551Z","updated_at":"2024-12-28T09:52:28.009Z","avatar_url":"https://github.com/modern-agile-team.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# create-dev-portfolio\n\n![docker-badge](https://img.shields.io/badge/node-v16.18.0-green)\n![docker-badge](https://img.shields.io/badge/npm-v8.19.2-green)\n![dev-portfolio-badge](https://img.shields.io/badge/npm--dependency-dev--portfolio@v2.1.5-green)  \n![docker-badge](https://img.shields.io/badge/npx-orange)\n![docker-badge](https://img.shields.io/badge/boiler--plate--app-black)\n![docker-badge](https://img.shields.io/badge/Docker-red)\n![docker-compose-badge](https://img.shields.io/badge/Docker_Compose-red)\n![type-script-badge](https://img.shields.io/badge/TypeScript-blue)\n\n`create-dev-portfolio` is a boiler-plate application developed using the [dev-portfolio](https://github.com/modern-agile-team/dev-portfolio) library.\nIt supports both clients and servers, and if you follow the \u003ca href=\"recommended-systems\"\u003erecommended systems\u003c/a\u003e below, anyone can easily develop the web.\n\nIf you want to check the dev-portfolio library, please refer to the following link: [dev-portfolio](https://github.com/modern-agile-team/dev-portfolio)\n\n![ezgif com-gif-maker](https://user-images.githubusercontent.com/56839474/194718430-5404fa1f-c24b-48a0-8730-15db2d3bde00.gif)\n\n## List\n\n- \u003ca href=\"#recommended-systems\"\u003eRecommended systems\u003c/a\u003e\n- \u003ca href=\"#run\"\u003eRun\u003c/a\u003e\n- \u003ca href=\"#exit\"\u003eExit\u003c/a\u003e\n- \u003ca href=\"#deploy\"\u003eDeploy\u003c/a\u003e\n- \u003ca href=\"#tip\"\u003eTip\u003c/a\u003e\n- \u003ca href=\"#refers\"\u003eRefers\u003c/a\u003e\n  - \u003ca href=\"#swagger-api\"\u003eSwagger API\u003c/a\u003e\n  - \u003ca href=\"#infra-structure\"\u003eInfra Structure\u003c/a\u003e\n  - \u003ca href=\"#database-erd\"\u003eDatabase ERD\u003c/a\u003e\n  - \u003ca href=\"#example\"\u003eExample\u003c/a\u003e\n- \u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\n- \u003ca href=\"#contributor\"\u003eContributor\u003c/a\u003e\n\n## Recommended systems\n\n**Operating System**: Linux \u0026 MacOS\n\n\u003e Windows is also available, but bash terminal is recommended, and the following tools must be operated based on bash.\n\n**Tools**\n\n1. recommended: **Bash terminal**\n2. required: **Docker** \u0026 **Docker-compose**\n   - Install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).\n     \u003e If **mac** and **windows** have **docker desktop** installed, **docker compose** is also installed, so there is no need to install it separately.\n     1. Click [here](https://docs.docker.com/get-docker/) to install Docker.\n     2. Click [here](https://docs.docker.com/compose/install/) to install Docker Compose.\n3. **node** ≥ `v16.18.0`\n   - Using nvm, you can easily change the node version. Please refer to the following: [NVM](https://www.notion.so/NVM-53c04d5c8837480e8601e6bd39abc62a#6db02c02a5c549cbaaa7884cac709a9e)\n4. **npm** ≥ `v8.19.2`\n\n## Run\n\n1. Install this repo.\n\n```bash\n# Install this repo\n$ npx create-dev-portfolio \u003cYOUR_APP_NAME\u003e\n```\n\n2. Run `dev-portfolio` by daemon.\n\n```bash\n# If you want to run both the client and the server, enter the command below.\n$ npm run start:all\n\n# Run only the client.\n$ npm run start:client\n\n# Run only the server.\n$ npm run start:server\n```\n\n## Exit\n\n```bash\n# If you want to exit both the client and the server, enter the command below.\n$ npm run exit:all\n\n# Exit only the client.\n$ npm run exit:client\n\n# Exit only the server.\n$ npm run exit:server\n```\n\n## Deploy\n\nPlease note that **only [client-app](https://github.com/modern-agile-team/create-dev-portfolio/tree/master/client/app) are deployed** except for [server-app](https://github.com/modern-agile-team/create-dev-portfolio/tree/master/server) on [Vercel](https://vercel.com/). If you want to deploy the server code, you have to deploy it directly using the cloud provided by AWS, GCP, Oracle, etc.  \nThe deploying guide will be released soon, so please look forward to it.\n\n```bash\n# If you enter the command below, the deploy will proceed automatically to the web page where new URL is registered on Vercel.\n$ npm run deploy:client\n```\n\n## Tip\n\n1.  **If you want to customize your client.  \n    Check to README.md in [dev-portfolio](https://github.com/modern-agile-team/dev-portfolio).**  \n    please go to the link below!\n\n        https://github.com/modern-agile-team/dev-portfolio/blob/master/README.md\n\n2.  **If you want to change environment variables such as PORT, DB.  \n    Customize files called `.*.env`.**  \n    By default, it works normally without modification.\n\n    ````bash # Move to dev-portfolio folder.\n    $ cd dev-portfolio\n\n       # Customize the .*.env file as you.\n       $ vi ./config/.client.env\n       $ vi ./config/.server.env\n       ```\n    ````\n\n## Refers\n\n### Swagger API\n\n\u003cimg width=\"1450\" alt=\"스크린샷 2022-09-12 오후 9 14 15\" src=\"https://user-images.githubusercontent.com/56839474/189650561-5ba9c467-b52c-48e6-b3e7-30813954e12d.png\"\u003e\n\nYou can view server apis very easily by using the Swagger documentation.  \nTo use the swagger, the `dev-portfolio` server must be in a working state.\n\nIf the server is up, go to the link below.\n\n```bash\nhttp://localhost:\u003cYOUR_SERVER_PORT\u003e/swagger\n```\n\n### Infra Structure\n\n\u003cimg width=\"1028\" alt=\"스크린샷 2022-09-15 오후 9 48 37\" src=\"https://user-images.githubusercontent.com/79014269/193828681-5d198fd9-9006-4713-a69b-ce576c58b442.png\"\u003e\n\n### Database ERD\n\n\u003cimg width=\"539\" alt=\"스크린샷 2022-10-12 오전 12 33 55\" src=\"https://user-images.githubusercontent.com/79014269/195138130-56656777-4440-426d-a88e-67c029cf5175.png\"\u003e\n\n### Example\n\n1. \u003c[dev-portfolio-app](https://github.com/modern-agile-team/dev-portfolio-app)\u003e http://52.78.64.144\n\n![ezgif com-gif-maker](https://user-images.githubusercontent.com/56839474/194718430-5404fa1f-c24b-48a0-8730-15db2d3bde00.gif)\n\n\u003cbr\u003e\n\n2. \u003c[woorim960](https://github.com/woorim960/woorim-personal-website)\u003e http://152.70.89.184\n\n![ezgif com-gif-maker (1)](https://user-images.githubusercontent.com/56839474/194719475-1cc2469e-7b7b-4ef0-8f87-236fa3aefbe1.gif)\n\n\u003cbr\u003e\n\n3. \u003c[seohyunsim](https://github.com/seohyunsim/seohyunsim-portfolio)\u003e https://seohyunsim-portfolio.vercel.app/\n\n\u003cimg width=\"1000\" alt=\"스크린샷 2022-09-12 오후 8 52 52\" src=\"https://user-images.githubusercontent.com/56839474/189646646-7faf4842-e881-42bc-bcb9-422975adac95.png\"\u003e\n\n\u003cbr\u003e\n\n## License\n\n[MIT](https://github.com/modern-agile-team/create-dev-portfolio/blob/master/LICENSE)\n\n## Contributor\n\n- [seohyunsim](https://github.com/seohyunsim)\n- [soonki-98](https://github.com/soonki-98)\n- [jisu3817](https://github.com/jisu3817)\n- [woorim960](https://github.com/woorim960)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodern-agile-team%2Fcreate-dev-portfolio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmodern-agile-team%2Fcreate-dev-portfolio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodern-agile-team%2Fcreate-dev-portfolio/lists"}