create-dev-portfolio

create-dev-portfolio is a boiler-plate application developed using the 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

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 and Docker Compose.

     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 to install Docker.
     2. Click here to install Docker Compose.
3. node ≥ v16.18.0
   • Using nvm, you can easily change the node version. Please refer to the following: NVM
4. npm ≥ v8.19.2

Run

1. Install this repo.

# Install this repo
$ npx create-dev-portfolio <YOUR_APP_NAME>

2. Run dev-portfolio by daemon.

# 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

# 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 are deployed except for server-app on Vercel. 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.

# 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.
   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.

   $ 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.

http://localhost:<YOUR_SERVER_PORT>/swagger

Infra Structure

Database ERD

Example

1. <dev-portfolio-app> http://52.78.64.144

2. <woorim960> http://152.70.89.184

3. <seohyunsim> https://seohyunsim-portfolio.vercel.app/

License

MIT

Contributor

• seohyunsim
• soonki-98
• jisu3817
• woorim960