feat: init-express-backend (#6)
All checks were successful
Build Docker Image Front / run (push) Successful in 23s
Build Docker Image Back / run (push) Successful in 23s

Reviewed-on: #6
Co-authored-by: Clement <c.boesmier@aptatio.com>
Co-committed-by: Clement <c.boesmier@aptatio.com>
This commit is contained in:
Clement 2024-05-06 21:20:29 +02:00 committed by Clement
parent d5afe1631e
commit 1bbc7a2aa3
18 changed files with 11832 additions and 6 deletions

View File

@ -1,4 +1,4 @@
name: Build Docker Image # nom du workflow name: Build Docker Image Front # nom du workflow
on: #declancheur on: #declancheur
push: push:

View File

@ -0,0 +1,53 @@
name: Build Docker Image Back # nom du workflow
on: #declancheur
push:
branches:
- '*'
tags:
- v*
pull_request:
branches:
- master
jobs:
run: #jobs ID (nom du jobs)
runs-on: ubuntu-latest # environement de run
steps: # liste des étapes
- name: Checkout # rapatrie le depot
uses: actions/checkout@v3
- name: Docker meta
id: meta
uses: docker/metadata-action@v5
with:
images: |
git.lab-ouest.org/Epitech/ratrapage_T-WEB_back
tags: |
type=edge
type=ref,event=pr
type=ref,event=branch
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=semver,pattern=latest
- name: Login to Gitea
uses: docker/login-action@v3
with:
registry: git.lab-ouest.org
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_TOKEN }}
# - name: Set up Docker Buildx
# uses: docker/setup-buildx-action@v3
- name: Build and push back
uses: docker/build-push-action@v5
with:
context: ./Express/barAndCafe
push: true
file: ./Express/barAndCafe/Dockerfile
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

46
.github/workflows/build_jsdoc_drink.yml vendored Normal file
View File

@ -0,0 +1,46 @@
name: JsDocs
on:
pull_request:
branches:
- '*'
jobs:
coverage:
runs-on: ubuntu-latest
steps:
- name: Checkout # rapatrie le depot
uses: actions/checkout@v3
- name: Docker meta
id: meta
uses: docker/metadata-action@v5
with:
images: |
git.lab-ouest.org/Epitech/ratrapage_T-WEB_drink_jsdocs
tags: |
type=edge
type=ref,event=pr
type=ref,event=branch
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=semver,pattern=latest
- name: Login to Gitea
uses: docker/login-action@v3
with:
registry: git.lab-ouest.org
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_TOKEN }}
# - name: Set up Docker Buildx
# uses: docker/setup-buildx-action@v3
- name: Build and push docs
uses: docker/build-push-action@v5
with:
context: ./Express/barAndCafe
push: true
file: ./Express/barAndCafe/Dockerfile_docs
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

19
.github/workflows/run_back_test.yml vendored Normal file
View File

@ -0,0 +1,19 @@
name: Test and coverage
on:
pull_request:
branches:
- '*'
jobs:
coverage:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: ArtiomTr/jest-coverage-report-action@v2
with:
working-directory: Express/barAndCafe
test-script: npm run test
output: comment, report-markdown
prnumber: ${{ steps.findPr.outputs.number }}
custom-title: Coverage report for backend
github-token: ${{ secrets.PR_TOCKEN}}
annotations: none #disable annotation

View File

@ -0,0 +1,58 @@
#########
# Build #
#########
FROM docker.io/node:20-alpine as BUILD_IMAGE
# External deps (for node-gyp add: "python3 make g++")
RUN apk add --no-cache git
# run as non root user
USER node
# go to user repository
WORKDIR /home/node
# Add package json
ADD --chown=node:node package.json package-lock.json ./
# install dependencies from package lock
RUN npm ci
# Add project files
ADD --chown=node:node . .
# build
RUN npm run build
# remove dev deps
RUN npm prune --omit=dev
##############
# Production #
##############
FROM docker.io/node:20-alpine as PROD_IMAGE
# inform software to be in production
ENV NODE_ENV=production
ENV HOST=0.0.0.0
ENV RESOURCES_FOLDER=/home/node/.loop/uploads
# run as non root user
USER node
# go to work folder
WORKDIR /home/node
# Expose port
EXPOSE 3000
# Add Healthcheck
HEALTHCHECK --interval=10s --timeout=10s --start-period=5s --retries=3 CMD wget --no-verbose --tries=1 --spider http://localhost:3000 || exit 1
# copy from build image
COPY --chown=node:node --from=BUILD_IMAGE /home/node/node_modules ./node_modules
COPY --chown=node:node --from=BUILD_IMAGE /home/node/dist ./dist
COPY --chown=node:node --from=BUILD_IMAGE /home/node/package.json /home/node/.env* ./
# run it !
CMD ["npm", "run", "start"]

View File

@ -0,0 +1,35 @@
#########
# Build #
#########
FROM docker.io/node:20-alpine as BUILD_IMAGE
# External deps (for node-gyp add: "python3 make g++")
RUN apk add --no-cache git
# run as non root user
USER node
# go to user repository
WORKDIR /home/node
# Add package json
ADD --chown=node:node package.json package-lock.json ./
# install dependencies from package lock
RUN npm ci
# Add project files
ADD --chown=node:node . .
# build
RUN npm run docs
# remove dev deps
RUN npm prune --omit=dev
##############
# Production #
##############
FROM httpd:alpine
COPY --from=BUILD_IMAGE /home/node/out/ /usr/local/apache2/htdocs/

View File

@ -0,0 +1,20 @@
/** @type {import('ts-jest').JestConfigWithTsJest} */
module.exports = {
preset: 'ts-jest',
testEnvironment: 'node',
collectCoverage: true,
coverageDirectory: 'coverage',
collectCoverageFrom: [
'**/*.ts',
'!/nodemodules/',
'!/jest.config.js/',
'!/coverage/',
'!**/server.ts',
'!**/swaggerDef.ts'
],
coverageThreshold: {
global: {
lines: 80,
},
},
};

View File

@ -0,0 +1,15 @@
{
"opts": {
"template": "node_modules/better-docs"
},
"tags": {
"allowUnknownTags": true
},
"plugins": [
"node_modules/better-docs/typescript"
],
"source": {
"include": ["./src"],
"includePattern": "\\.(jsx|js|ts|tsx)$"
}
}

11251
Express/barAndCafe/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,35 @@
{
"main": "dist/server.js",
"scripts": {
"build": "rimraf dist && npx tsc",
"start": "node dist/src/server.js",
"predev": "npm run build",
"dev": "npx tsc -w & nodemon dist/src/server.js",
"docs": "jsdoc -c jsdoc.json",
"test": "jest"
},
"dependencies": {
"@types/express": "^4.17.21",
"@types/node": "^20.12.7",
"dotenv": "^16.4.5",
"express": "^4.19.2",
"rimraf": "^5.0.5",
"swagger-jsdoc": "^6.2.8",
"swagger-ui-express": "^5.0.0"
},
"devDependencies": {
"@types/jest": "^29.5.12",
"@types/supertest": "^6.0.2",
"babel-cli": "^6.26.0",
"babel-preset-env": "^1.7.0",
"better-docs": "^2.7.3",
"jest": "^29.7.0",
"jsdoc": "^4.0.3",
"nodemon": "^3.1.0",
"superagent": "^9.0.2",
"supertest": "^7.0.0",
"ts-jest": "^29.1.2",
"typedoc": "^0.25.13",
"typescript": "^5.4.5"
}
}

View File

@ -0,0 +1,32 @@
import express from "express"
/**
* Initialize Express application instance.
* @returns An initialized Express application object.
*/
const app = express()
/**
* Handle GET request for homepage route ('/welcome').
* Send back a simple json response.
* @param {express.Request} req - HTTP Request object.
* @param {express.Response} res - HTTP Response object.
*/
function getWelcome(req: express.Request, res: express.Response) {
const out = {hello:"world"}
res.send(out)
}
/**
* @openapi
* /welcome:
* get:
* description: Welcome to swagger-jsdoc!
* responses:
* 200:
* description: Returns a welcome json.
*/
app.get("/welcome", getWelcome)
export default app

View File

@ -0,0 +1,16 @@
import * as dotenv from "dotenv";
import app from "./app";
import options from "./swaggerDef";
const swaggerJsdoc = require("swagger-jsdoc"),
swaggerUi = require("swagger-ui-express");
dotenv.config({path: '../../.env'})
const port = parseInt(process.env.BAR_PORT || '3000')
const specs = swaggerJsdoc(options)
app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(specs))
app.listen(port, () =>{
console.log(`serveur running in ${port}`)
})

View File

@ -0,0 +1,26 @@
import * as dotenv from "dotenv";
dotenv.config({path: '../../.env'})
const port = parseInt(process.env.BAR_PORT || '3000')
const options = {
definition: {
openapi: "3.1.0",
info: {
title: "LogRocket Express API with Swagger",
version: "0.1.0",
description:
"This is a simple CRUD API application made with Express and documented with Swagger",
},
servers: [
{
url: "http://localhost:"+port.toString(),
},
],
},
apis: ['./src/*.ts'],
explorer: true
}
export default options

View File

@ -0,0 +1,41 @@
import request from "supertest";
import app from "../src/app";
import { Server, IncomingMessage, ServerResponse } from "http";
import * as dotenv from "dotenv";
dotenv.config({path: '../../.env'})
const port = parseInt(process.env.BAR_PORT || '3000')
let serveur : Server<typeof IncomingMessage, typeof ServerResponse>
describe("Test the welcome path", () => {
beforeEach(() => {
serveur = app.listen(port, () =>{
console.log(`serveur running in ${port}`)
})
})
afterEach((done) => {
serveur.close(done)
})
test("It should response the GET method", done => {
request(app)
.get("/welcome")
.then(response => {
expect(response.statusCode).toBe(200);
done();
});
});
test("It should response the GET method", done => {
const out = {hello:"world"};
request(app)
.get("/welcome")
.then(response => {
expect(response.text).toEqual(JSON.stringify(out))
done();
});
});
});

View File

@ -0,0 +1,109 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
"baseUrl": "src", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
"rootDirs": ["./src"], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}

View File

@ -0,0 +1,11 @@
meta {
name: express test
type: http
seq: 3
}
get {
url: http://localhost:3000
body: none
auth: none
}

@ -1 +1 @@
Subproject commit 5175e1fdf116eb7c370b629ff96aee7b308d250f Subproject commit fb594bfd7c715a891f076750403e3a439b804468

View File

@ -1,12 +1,14 @@
version: "3.8" version: "3.8"
services: services:
pocketbase: pocketbase:
image: ghcr.io/coollabsio/pocketbase:latest image: ghcr.io/coollabsio/pocketbase:latest
environment: environment:
- SERVICE_FQDN_POCKETBASE_8080 - SERVICE_FQDN_POCKETBASE_8080
volumes: volumes:
- ./.pb/pocketbase-data:/app/pb_data - ./pb/pocketbase-data:/app/pb_data
- ./.pb/pocketbase-hooks:/app/pb_hooks - ./pb/pocketbase-hooks:/app/pb_hooks
labels: labels:
- traefik.enable=true - traefik.enable=true
- traefik.http.routers.poketBaseTweb.rule=Host(`${POCKET_BASE_URL}`) - traefik.http.routers.poketBaseTweb.rule=Host(`${POCKET_BASE_URL}`)
@ -14,9 +16,10 @@ services:
- traefik.http.routers.poketBaseTweb.tls.certresolver=le - traefik.http.routers.poketBaseTweb.tls.certresolver=le
networks: networks:
- public - public
front: front:
image: git.lab-ouest.org/epitech/ratrapage_t-web_front:pr-7-head image: git.lab-ouest.org/epitech/ratrapage_t-web_front:pr-1-head
depends_on: depends_on:
- pocketbase - pocketbase
labels: labels:
- traefik.enable=true - traefik.enable=true
@ -25,10 +28,66 @@ services:
- traefik.http.routers.astroTweb.tls.certresolver=le - traefik.http.routers.astroTweb.tls.certresolver=le
networks: networks:
- public - public
back_drink:
image: git.lab-ouest.org/epitech/ratrapage_t-web_back:pr-6-head
labels:
- traefik.enable=true
- traefik.http.routers.expressDrinkTweb.rule=Host(`${DRINK_URL}`)
- traefik.http.services.expressDrinkTweb.loadbalancer.server.port=${BACK_BASE_PORT}
- traefik.http.routers.expressDrinkTweb.tls.certresolver=le
networks:
- public
docs_drink:
image: git.lab-ouest.org/epitech/ratrapage_t-web_drink_jsdocs:pr-6-head
labels:
- traefik.enable=true
- traefik.http.routers.docsDrinkTweb.rule=Host(`${DOCS_DRINK_URL}`)
- traefik.http.services.docsDrinkTweb.loadbalancer.server.port=${DOCS_BACK_BASE_PORT}
- traefik.http.routers.docsDrinkTweb.tls.certresolver=le
networks:
- public
blazegraph:
image: conjecto/blazegraph:2.1.5
# ports:
# - 9999:9999
environment:
JAVA_OPTS: -Xms6G -Xmx6G
volumes:
- ./datatourisme/dataset:/docker-entrypoint-initdb.d
ulimits:
nofile:
soft: 65536
hard: 65536
networks:
- graphQL
restart: unless-stopped
datatourisme:
image: git.lab-ouest.org/epitech/fork-open-data-tourism:master
depends_on:
- blazegraph
networks:
- graphQL
- public
restart: unless-stopped
labels:
- traefik.enable=true
- traefik.http.routers.dataTourisme.rule=Host(`${DATA_TOURISME_URL}`)
- traefik.http.services.dataTourisme.loadbalancer.server.port=${DATA_TOURISME_BASE_PORT}
- traefik.http.routers.dataTourisme.tls.certresolver=le
networks: networks:
graphQL: {}
public: public:
external: true external: true
x-dockge: x-dockge:
urls: urls:
- https://${POCKET_BASE_URL}/ - https://${POCKET_BASE_URL}/
- https://${FRONT_URL}/ - https://${FRONT_URL}/
- https://${DOCS_DRINK_URL}/
- https://${DRINK_URL}/
- https://${DATA_TOURISME_URL}/