Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/modern-agile-team/create-dev-portfolio
create-dev-portfolio is a boiler-plate application developed using the dev-portfolio library
https://github.com/modern-agile-team/create-dev-portfolio
dev-portfolio docker-compose npx typescript
Last synced: 11 days ago
JSON representation
create-dev-portfolio is a boiler-plate application developed using the dev-portfolio library
- Host: GitHub
- URL: https://github.com/modern-agile-team/create-dev-portfolio
- Owner: modern-agile-team
- License: mit
- Created: 2022-09-03T01:46:48.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-10-28T09:36:27.000Z (about 2 years ago)
- Last Synced: 2023-05-07T12:38:27.713Z (over 1 year ago)
- Topics: dev-portfolio, docker-compose, npx, typescript
- Language: TypeScript
- Homepage:
- Size: 2.46 MB
- Stars: 30
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-dev-portfolio
`create-dev-portfolio` is a boiler-plate application developed using the [dev-portfolio](https://github.com/modern-agile-team/dev-portfolio) library.
It supports both clients and servers, and if you follow the recommended systems below, anyone can easily develop the web.
If you want to check the dev-portfolio library, please refer to the following link: [dev-portfolio](https://github.com/modern-agile-team/dev-portfolio)
## List
- Recommended systems
- Run
- Exit
- Deploy
- Tip
- Refers
- Swagger API
- Infra Structure
- Database ERD
- Example
- License
- Contributor
## Recommended systems
**Operating System**: Linux & MacOS
> Windows is also available, but bash terminal is recommended, and the following tools must be operated based on bash.
**Tools**
1. recommended: **Bash terminal**
2. required: **Docker** & **Docker-compose**
- Install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).
> If **mac** and **windows** have **docker desktop** installed, **docker compose** is also installed, so there is no need to install it separately.
1. Click [here](https://docs.docker.com/get-docker/) to install Docker.
2. Click [here](https://docs.docker.com/compose/install/) to install Docker Compose.
3. **node** ≥ `v16.18.0`
- Using nvm, you can easily change the node version. Please refer to the following: [NVM](https://www.notion.so/NVM-53c04d5c8837480e8601e6bd39abc62a#6db02c02a5c549cbaaa7884cac709a9e)
4. **npm** ≥ `v8.19.2`
## Run
1. Install this repo.
```bash
# Install this repo
$ npx create-dev-portfolio
```
2. Run `dev-portfolio` by daemon.
```bash
# If you want to run both the client and the server, enter the command below.
$ npm run start:all
# Run only the client.
$ npm run start:client
# Run only the server.
$ npm run start:server
```
## Exit
```bash
# If you want to exit both the client and the server, enter the command below.
$ npm run exit:all
# Exit only the client.
$ npm run exit:client
# Exit only the server.
$ npm run exit:server
```
## Deploy
Please 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.
The deploying guide will be released soon, so please look forward to it.
```bash
# If you enter the command below, the deploy will proceed automatically to the web page where new URL is registered on Vercel.
$ npm run deploy:client
```
## Tip
1. **If you want to customize your client.
Check to README.md in [dev-portfolio](https://github.com/modern-agile-team/dev-portfolio).**
please go to the link below!
https://github.com/modern-agile-team/dev-portfolio/blob/master/README.md
2. **If you want to change environment variables such as PORT, DB.
Customize files called `.*.env`.**
By default, it works normally without modification.
````bash # Move to dev-portfolio folder.
$ cd dev-portfolio
# Customize the .*.env file as you.
$ vi ./config/.client.env
$ vi ./config/.server.env
```
````
## Refers
### Swagger API
You can view server apis very easily by using the Swagger documentation.
To use the swagger, the `dev-portfolio` server must be in a working state.
If the server is up, go to the link below.
```bash
http://localhost:/swagger
```
### Infra Structure
### Database ERD
### Example
1. <[dev-portfolio-app](https://github.com/modern-agile-team/dev-portfolio-app)> http://52.78.64.144
2. <[woorim960](https://github.com/woorim960/woorim-personal-website)> http://152.70.89.184
3. <[seohyunsim](https://github.com/seohyunsim/seohyunsim-portfolio)> https://seohyunsim-portfolio.vercel.app/
## License
[MIT](https://github.com/modern-agile-team/create-dev-portfolio/blob/master/LICENSE)
## Contributor
- [seohyunsim](https://github.com/seohyunsim)
- [soonki-98](https://github.com/soonki-98)
- [jisu3817](https://github.com/jisu3817)
- [woorim960](https://github.com/woorim960)