Internships manager

Internships manager

  • Docs
  • API
  • Tuto
  • Help
  • GitHub

›Get started

Get started

  • Installation
  • Settings

Services

  • Mailer service

Software architecture

  • Back end part
  • Front end part

Installation

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 a running developpement server

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

The .env file must contain followings code. To get detail about this part, go to settings in documentation.

# Note we depend on NODE_ENV being set to dictate which of the env variables below get loaded at runtime.
# See README for more details.

MYSQL_HOST=localhost
MYSQL_USER=root
MYSQL_DATABASE=internships
MYSQL_PASSWORD=

# Set true to drop database on server start
ORM_DROP_DB_ON_START=false
ORM_LOGGING=false

# CAS connection
CAS_URL=https://my-cas-host.com/cas
SERVICE_URL=https://my-service-host.com
CAS_DEV_MODE=true

# Put lots of randomness in these
SESSION_SECRET=ashdfjhasdlkjfhalksdjhflak
HASH_KEY=gLgk8Nt7ograVzCsgQz1JM05QJtpzDbk

# API Version
INTERNSHIP_ENIB_API_VERSION=v1
INTERNSHIP_ENIB_API_PORT=4000

# Mailer
SMTP_HOST='smtp.ethereal.email'
SMTP_PORT=587
SMTP_SECURE=false
SMTP_AUTH_USER=
SMTP_AUTH_PASS=

BASE_STORAGE_DIR=/caches

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 the live server. The live server will be available on port 4000 for graphical interface and 9527 for the API

  • API: http://localhost:4000/api/v1
  • Interface: http://localhost:9527
Settings →
  • Requirement
  • Setup a running developpement server
Copyright © 2019 ENIB