Fix nest libertech template

Author: tacxou

.env.example

@@ -1,21 +1,16 @@
-APPNAME=template
+APPNAME=mailrest
 
-MONGOOSE_URL=mongodb://template-mongodb:27017/myreport
 IOREDIS_URL=redis://template-redis:6379/1
 
 JWT_SECRET=1212974
 CRYPT_SECURITYKEY=78987946
 
-PASSPORT_LDAP_URL=ldap://template-openldap:389
-PASSPORT_LDAP_BINDDN=cn=admin,dc=test,dc=local
-PASSPORT_LDAP_BINDCREDENTIALS=
-PASSPORT_LDAP_SEARCHBASE=dc=test,dc=local
-LDAP_LOG_LEVEL=trace
-
 MAILER_TRANSPORT_HOST=template-maildev
 MAILER_TRANSPORT_PORT=1025
 MAILER_TRANSPORT_SECURE=0
 MAILER_TRANSPORT_IGNORETLS=0
 MAILER_TRANSPORT_AUTHUSER=''
 MAILER_TRANSPORT_AUTHPASS=''
-MAILER_DEFAULTS_FROM="'test' <test@test.com>"
+MAILER_DEFAULTS_FROM="'test' <test@test.com>"
+# https://ethereal.email/
+# https://webhook.site/

.eslintrc.js

@@ -24,4 +24,4 @@ module.exports = {
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-var-requires': 'off',
   },
-};
+}

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
+documentation/
 dist/
 .DS_Store/
 .idea/

.prettierrc

@@ -4,6 +4,6 @@
   "singleQuote": true,
   "trailingComma": "all",
   "arrowParens": "always",
-  "printWidth": 120,
+  "printWidth": 150,
   "bracketSpacing": true
 }

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased] - 2023-08-03
+ 
+Generating a basic project structure
+ 
+### Added
+- [MAILREST#1](https://github.com/Libertech-FR/mailrest/issues/1)
+  Define base structure.
+- [MAILREST#2](https://github.com/Libertech-FR/mailrest/issues/2)
+  Create basic documentation.
+- [MAILREST#3](https://github.com/Libertech-FR/mailrest/issues/3)
+  Implements github workflows.
+<!-- ### Changed -->
+<!-- ### Fixed -->

Dockerfile

@@ -39,6 +39,6 @@ RUN yarn install \
 
 COPY --from=builder /usr/src/app/dist ./dist
 
-EXPOSE 4000
+EXPOSE 7000
 
 CMD ["yarn", "start:prod"]

Makefile

@@ -1,19 +1,11 @@
-IMGNAME?=exemple
-APPNAME?=exemple
-APPPORT?=4500
-
-LDAPORGANISATION?=exemple
-LDAPDOMAIN?=exemple.local
-LDAPPASSWORD?=
-OPENLDAP_PORT?=389
-
-MAILDEVPORTWEB?=1080
-MAILDEVPORTMAIL?=1025
+IMGNAME?=ghcr.io/libertech-fr/mailrest
+APPNAME?=mailrest
+APPPORT?=7000
 
 init:
 	@docker build -t $(IMGNAME) .
 	@docker exec -it $(APPNAME) yarn install
-	
+
 build:
 	docker build -t $(IMGNAME) .
 
@@ -30,7 +22,7 @@ dev:
 		--add-host host.docker.internal:host-gateway \
 		--name $(APPNAME) \
 		--network dev \
-		-p $(APPPORT):4000 \
+		-p $(APPPORT):7000 \
 		-v $(CURDIR):/usr/src/app \
 		$(IMGNAME) yarn start:dev
 
@@ -46,64 +38,16 @@ generate:
 	@docker exec -it $(APPNAME) yarn generate
 
 dbs:
-	@docker run --rm -d \
- 		--name $(APPNAME)-openldap \
-		-e LDAP_ORGANISATION=$(LDAPORGANISATION) \
-		-e LDAP_DOMAIN=$(LDAPDOMAIN) \
-		-e LDAP_ADMIN_PASSWORD=$(LDAPPASSWORD) \
-		--network dev \
-		-v $(CURDIR)/openldap/custom:/container/service/slapd/assets/config/bootstrap/ldif/custom \
-		-p $(OPENLDAP_PORT):389 \
-		osixia/openldap:1.5.0 --loglevel debug --copy-service
-
 	@docker volume create $(APPNAME)-redis
 	@docker run -d --rm \
 		--name $(APPNAME)-redis \
 		--network dev \
 		-p 6379:6379 \
 		redis
-	@docker volume create $(APPNAME)-mongodb
-	@docker run -d --rm \
-		--name $(APPNAME)-mongodb \
-		-v $(APPNAME)-mongodb:/data/db \
-		-p 27017:27017 \
-		--network dev \
-		mongo:5.0 --wiredTigerCacheSizeGB 1.5 --quiet || true
-
-	@docker run --rm -d \
-		--name $(APPNAME)-ldapadmin \
-		-e PHPLDAPADMIN_LDAP_HOSTS=ga.service.usermanager.openldap \
-		-e PHPLDAPADMIN_LDAP_HOSTS="#PYTHON2BASH:[{'$(APPNAME)-openldap': [{'login': [{'bind_id': 'cn=admin,dc=test,dc=local'}]}]}]" \
-		-v $(CURDIR)/phpldapadmin/exemples/:/data/exemples \
-		-p 6443:443 \
-		--network dev \
-		osixia/phpldapadmin || true
-
-	@docker run --rm -d --name $(APPNAME)-maildev \
-  		-p $(MAILDEVPORTWEB):1080 \
-  		-p $(MAILDEVPORTMAIL):1025 \
-  		--network dev \
-  		maildev/maildev || true
 
 stop:
-	@docker stop $(APPNAME)-maildev || true
-	@docker stop $(APPNAME)-ldapadmin || true
-	@docker stop $(APPNAME)-mongodb || true
 	@docker stop $(APPNAME)-redis || true
-	@docker stop $(APPNAME)-openldap || true
 	@docker stop $(APPNAME) || true
 
 rm:
 	docker rm $(shell docker ps -a -q -f name=$(APPNAME))
-
-
-openldap:
-	docker run --rm -it \
- 		--name $(APPNAME)-openldap \
-		-e LDAP_ORGANISATION=$(LDAPORGANISATION) \
-		-e LDAP_DOMAIN=$(LDAPDOMAIN) \
-		-e LDAP_ADMIN_PASSWORD=$(LDAPPASSWORD) \
-		--network dev \
-		-v $(CURDIR)/openldap/custom:/container/service/slapd/assets/config/bootstrap/ldif/custom \
-		-p $(OPENLDAP_PORT):389 \
-		osixia/openldap:1.5.0 --loglevel trace --copy-service

config/accounts.sample.yml

@@ -0,0 +1,17 @@
+version: '1'
+
+mailboxes:
+  - id: 'my.mailbox'
+    name: 'Mailbox 1'
+    imap:
+      host: 'imap.gmail.com'
+      port: 993
+      tls: true
+      username: ''
+      password: ''
+    smtp:
+      host: 'smtp.gmail.com'
+      port: 465
+      tls: true
+      username: ''
+      password: ''

config/tokens.sample.yml

@@ -0,0 +1,5 @@
+version: '1'
+
+tokens:
+  - key: 2135646
+    ip: ['127.0.0.1']

jest.config.ts

@@ -0,0 +1,16 @@
+module.exports = {
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  rootDir: '.',
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/src/**/*spec.ts'],
+  transform: {
+    '^.+\\.(t|j)s$': [
+      'ts-jest',
+      {
+        tsconfig: '<rootDir>/tsconfig.json',
+        ignoreCodes: ['TS151001'],
+      },
+    ],
+  },
+  collectCoverage: true,
+}