Internships manager

Sonar - backend:

Sonar - frontend:

Summary

• Requirement
• Setup
• Back-end
  • Structure
  • CMD
• Front-end
  • Structure
  • CMD
• Documentation
• Contribution
• Licence
• Usefull links

Requirement

• NodeJS X >= 8
• MySQL or other database manager supported by Sequelize. If you use another provide than mysql, please change settings in services/src/configs/instances/database.ts.

Setup

To setup this projet, you need to create an empty SQL table in your database nammed gstStage. Then, indicate in your services/.env file the connection information (host, username, password).

Then you can run npm i or npm install to run install for both back and front end.

Run npm run build to compile every fill and npm run serve to start live server. Live server will be available on port 9500 for graphical interface and 9501 for the API

Back end

Backend part of the project is contain under the services directory. We decide to separate back-end and front-end with an Express API to be able to easly deploy multiple front-end view and separate data management from visualization.

The back-end part was developed using TypeScript.

Back end code structure

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

• devops/ (Scripts for setup and preparations)

• dist/ (Compiled files)

• node_modules/ (All dependecies are here after you run npm i)

• src/ (directory for TypeScript code)

  • api/ (all API files)

    • controllers/ (Declare methods to handle each endpoints)
    • helpers/ (Declare methods to factorize)
    • processors/ (Declare methods to process given data)
    • routers/ (Declare route of API for each endpoints)
    • validators/ (Declare schema for validate given data)

  • auth/ (all files link to authentication)

    • cas/ (all files link to authentication via CAS)

  • configs/ (files used for configuration and setup of the server)

  • declarations/ (Declaration of all interfaces used in projects)

  • emails/ (Email services)

    • build/ (Files use during templates builds)
    • templates/ (All emails templates, 1 directory = 1 template)

  • files-storage/ (Files storages service)

  • helpers/ (Global helpers)

  • internship/ (Internship service, including FSM)

  • models/ (Every models used to isolate database from code, coded for Sequelize )

    • sequelize/ (All sequelizes models)

  • utils/ (Every utility files)

  • websocket/ (Websocket service, see socket.io)

  • app.ts (application file, prepare the application without running it)

  • server.ts (run server entry point)

• .env (environment variables to config database and api - DotEnv)

• jest.config.js (configuration file for Jest - CI)

• montoring..log* (log files to debug API using Winston)

• package.json (npm package and dependecie configuration)

• tsconfig.json (TypeScript configuration file)

• tslint.json (TypeScript linter configs)

Back end CMD

• npm run build: Compile back-end server
• npm run serve: Run server
• npm run watch: Run server and reload on file save
• npm run test: Run test for server
• npm run lint: Run linter on src files
• npm run debug: Run server in debug mode and reload on file save

Front end

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

Documentation

Available here

Contribution

• Oscar MARIE--TAILLEFER oscar@leeap.cash
• André FELIX
• Adrien Tissier a5tissie@enib.fr
• Océane Cloarec o3cloare@enib.fr

Licence

MIT License

Copyright (c) 2019 Oscar MARIE--TAILLEFER

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usefull links

• Base template: Vue Typescript Admin Template
• Vue framework: Element
• Vue JS documentation: VueJS
• Test framework: Jest
• Typescript
• Mailer documentation: Nodemailer and email-templates
• CAS authentication: cas-authentication
• Websocket: socket-io
• Web visualisation: Echarts