traPtitech / traPortfolio

traPortfolio

• Backend
  • traPtitech/traPortfolio (this repository)
• Frontend
  • traPtitech/traPortfolio-UI
  • traPtitech/traPortfolio-Dashboard

Develop environment

If you want to contribute to traPortfolio, then follow these pages.

• Architecture memo (in Japanese)
• API schema
• DB schema

Quick start with DevContainer (Recommended)

If you use VSCode, you can use DevContainer to develop traPortfolio. See ./.devcontainer/README.md for more details.

Requirements (for local development)

• Bash
• make
• Docker
• Docker Compose
• Go
• MySQL

Start docker container (with Docker Compose)

docker compose up

Tips: You can change the configuration by rewriting ./dev/config.yaml

Now you can access to

• http://localhost:1323 for backend server.
• http://localhost:3001 for adminer
  • username: root
  • password: password
  • database: portfolio
  • port: 3306

Run locally

NOTE: Make sure backend container is stopped because of port conflicts

make up-db-container
go run main.go -c ./dev/config.yaml

Tips: You can change the configuration by

• Specifying it with flags (Run go run main.go --help)
• Rewriting ./dev/config.yaml

Generate DB docs

make db-gen-docs

Run linters

DB linter (tbls)

make db-lint

OpenAPI linter (spectral)

make openapi-lint

Go linter (golangci-lint)

make lint

Run tests

Unit tests

make test

Integration tests

make test-integration

If you want to test both of them, run the following command.

make test-all