Internships manager

Internships manager

  • Docs
  • API
  • Tuto
  • Help
  • GitHub

›Software architecture

Get started

  • Installation
  • Settings

Services

  • Mailer service

Software architecture

  • Back end part
  • Front end part

Front end part

The webapp is the front-end part of the internships manager developped in TypeScript using VueJS. It is used to render all internships info and to easly configure campagnes for internships management.

Front end code structure

Under the front-end directory app, you will be able to find the following code architecture:

  • dist/ (Compiled files)
  • node_modules/ (All dependecies are here after you run npm i)
  • public/ (All static files of the application)
  • src/ (All developpements files)
    • api/ (API interface to handle server API calls)
    • assets/ (every static files in applications as photos, movies ... )
    • components/ (Every components used in the view)
    • directives/ (Every directives for vue components)
    • filters/ (Every filter for vue components)
    • icons/ (Every icons used in application)
    • lang/ (Languages files @see Vue-i18n)
    • layout/ (Components to compose layout of application)
    • router/ (Router of application @see Vue-router)
    • store/ (Shared store of application @see Vuex)
    • styles/ (Every styles sheets)
    • utils/ (Utils file to manage various case)
    • views/ (All views of the application)
  • tests/ (Tests directory for Jest and Cypress)
  • .browserslistrc (list of all suported browsers)
  • .env.* (environment variables to config API connection - DotEnv)
  • .eslintignore (ignore file for eslint linter)
  • .eslintrc.js (config file for eslint linter)
  • .prettierrc.js (config file for prettier plugin)
  • babel.config.js (config file for babel, the VueJS transpiler)
  • cypress.json (config file for E2E framework cypress)
  • jest.config.json (config file for Jest test framework)
  • package.json (npm package and dependecie configuration)
  • postcss.config.js (config file for PostCSS, style compilator in VueJS)
  • tsconfig.json (TypeScript configuration file)
  • vue.config.js (config file for VueJS)

Front end CMD

  • npm run server: Run server in dev mode
  • npm run build:prod: Build server in production mode
  • npm run build:stage: Build server in staging mode
  • npm run lint: Run linter on src files
  • npm run svg: Build icon
  • npm run test:unit: Run unit test
  • npm run test:e2e: Run end-to-end test
← Back end part
  • Front end code structure
  • Front end CMD
Copyright © 2019 ENIB