Skip to content

Latest commit

 

History

History
287 lines (235 loc) · 7.22 KB

README.md

File metadata and controls

287 lines (235 loc) · 7.22 KB

Portal Site For Nuxt2 Study

Twitter: N-LAB

日本語版 README はこちら

I created this project for a nuxt learning purpose. You can do the following in this application.

  • Create account
  • Change account password
  • Login with account created this application
  • Show account info

This project consists of frontend project + backend project.

project_root
├── frontend (Nuxt2)
└── backend (Express)

Frontend project is created by Nuxt2. This project use following.

  • TypeScript
  • Nuxt/auth
  • Nuxt/axios
  • Font Awesome
  • Bulma CSS
  • Vee-Validate
  • SweetAlert2
  • Jest
  • Jest Puppeteer
  • SonarQube

Backend project is created by Express. This project use following.

  • TypeScript
  • CryptoJS
  • Helmet
  • TypeORM
  • Jest
  • SonarQube
  • JSONWebToken

Contents

  1. Prerequisites
  2. Demo
  3. Install
  4. Usage
  5. Run unit tests
  6. Run e2e tests
  7. Analyze project
  8. License
  9. Author

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

  • Git - Download & Install Git. OSX and Linux machines typically have this already installed.
  • Node.js - Download & Install Node.js (Install v16.x, do not install v18) and the npm package manager.

Demo

  • Create account

  • Change account password

  • Login and show account info

Install

・ Frontend

# Go into the frontend project
$ cd frontend

# Install dependencies
$ npm install

・ Backend

# Go into the backend project
$ cd backend

# Install dependencies
$ npm install

Usage

To start this application, run below command line.

# Go into the frontend project
$ cd frontend

# Start application
$ npm run start:all

You can access http://localhost:3030 to use this application.

Run unit tests

・ Frontend

To run tests of frontend project, run below command line.

# Go into the frontend project
$ cd frontend

# Run all tests
$ npm run test:all

You can also run each test file.

Edit config:path in frontend/package.json.

{
  "config": {
    "path": "./src/test/pages/login.spec.ts",
  }
}

Then run below command line.

# Go into the frontend project
$ cd frontend

# Run test file defined config:path in frontend/package.json
$ npm run test

# If you use Windows, run below command instead of above command
$ npm run test:win

・ Backend

To run tests of backend project, run below command line.

# Go into the backend project
$ cd backend

# Run all tests
$ npm run test:all

You can also run each test file.

Edit config:path in backend/package.json.

{
  "config": {
    "path": "./src/test/controller/LoginController.spec.ts",
  }
}

Then run below command line.

# Go into the backend project
$ cd backend

# Run test file defined config:path in backend/package.json
$ npm run test

# If you use Windows, run below command instead of above command
$ npm run test:win

Run e2e tests

You can test each page by jest-puppeteer.

Edit config:e2e in frontend/package.json.

{
  "config": {
    "e2e": "./e2e/e2e-test/login.spec.ts",
  }
}

Then run below command line.

# Go into the frontend project
$ cd frontend

# Run e2e test file defined config:e2e in frontend/package.json
$ npm run test:e2e

# If you use Windows, run below command instead of above command
$ npm run test:e2e-win

Analyze project

You can analyze project by SonarQube. To do this, you have to install SonarQube in advance.

・ Frontend

After installing SonarQube, create project and generate project token. Project display name and project key must set up with the following name when you create project.

portal-frontend

Paste project token to config:token in frontend/package.json.

{
  "config": {
    "token": "sqp_XXXXXXXXX",
  }
}

Then run below command line.

# Go into the frontend project
$ cd frontend

# Run all tests
$ npm run test:all

# Run SonarQube
$ npm run sonar

# If you use Windows, run below command instead of above command
$ npm run sonar:win

You can access http://localhost:9000/dashboard?id=portal-frontend to show result.

・ Backend

After installing SonarQube, create project and generate project token. Project display name and project key must set up with the following name when you create project.

portal-backend

Paste project token to config:token in backend/package.json.

{
  "config": {
    "token": "sqp_XXXXXXXXX",
  }
}

Then run below command line.

# Go into the backend project
$ cd backend

# Run all tests
$ npm run test:all

# Run SonarQube
$ npm run sonar

# If you use Windows, run below command instead of above command
$ npm run sonar:win

You can access http://localhost:9000/dashboard?id=portal-backend to show result.

License

MIT

Author

👤 Naoki Nakanishi