Technical Documentation - xScorts

Owned by Steve Smith
Last updated: Nov 23, 2023

I. xScorts Tech stack

Backend

  1. NodeJS with NestJS framework

  2. MongoDB

  3. Redis

  4. FFMPEG

  5. Nginx with http_auth_module to protect assets

Frontend

  1. ReactJS with NextJS framework

  2. Ant design

II. QA

1. How to configure email?

xScorts provides 2 sections in the Admin settings for email

  • Email tab

    • Admin Email: Email address for who will receive notification from system and contact form

    • Sender Email: Email address for who will send the email in system

  • SMTP tab

    • Host: enter SMTP host Ex. smtp.google.com

    • Port: SMTP port Ex. 465

    • Auth User: SMTP username

    • Auth Password: SMTP password

    • Secure Option: Enable if use port 465

Note:

  • You can use format “your name” <email-address> to admin email and sender email. Eg

    • Admin Email: "xScorts Admin" <admin@xscorts.info >

    • Sender Email: "xScorts Support" <noreply@xscorts.info >

  • xScorts provides SMTP method for email only, almost services provide SMTP config, please check with your service and common list in our document.

2. How to add Google analytics code?

Go to Admin panel > Settings > System settings > Google Analytics and enter your GA code.

3. How to add custom script?

Go to Admin panel > Settings > System settings > Custom. There are 2 section you can enter your custom script

  • Custom Header Script: website will render this content in the <head> tag

  • Custom Body Script: website will render this content before </body> tag

4. How to update or change style?

xScorts does not provide option to change layout or style in the admin panel. However if you want to custom there are 2 solutions

  • Change style from source code (Recommended)

  • Or inspect element in xScorts HTML code and get CSS class name or section then update your style to “Custom header script” section.

5. How to setup xScorts payment gateway?

xScorts just supports CCBill payment gateway for now.

  • Go to Admin > Settings > System settings > CCbill and enter CCBill information in the form

  • CCBill webhook URL: https://[xScorts-v3-api-domain]/payment/ccbill/callhook (Ex - https://api.xScorts.info/payment/ccbill/callhook)

  • Approval URL (redirect URL after payment success) should be https://your-xscorts-domain/payment/success (Ex - https://xscorts.info/payment/success). You can See this field under CCBill sub account > Basic tab

  • Denial URL (redirect URL after payment failure or cancel payment) should be https://your-xscorts-domain (Ex - https://xscorts.info ). You can See this field under CCBill sub account > Basic tab

Go to Admin panel > FE Menu. Here you can see the list and create or update existing menu.

xScorts provides only option to change footer menu for now

  • From system page: FE will reload custom script file if it is system url. if enable you can select list of static pages too

  • Is new tab: open link in a new tab once clicking on

  • Title: menu text

  • Path: link to the page (you can enter full url here if it is not system page)

  • Section: where we will show the menu

  • Ordering: Enter sort number of menu item in the list

7. SMTP common list and setup

Sendgrid

  • Host: smtp.sendgrid.net

  • Port: 465 / 587

  • Auth User: the string apikey. This setting is the exact string "apikey" and not the API key itself.

  • Auth Password: your Sendgrid API key Ex - SG.xxxxx

Gmail

  • Host: smtp.sendgrid.net

  • Port: 465 / 587

  • Auth User: Your full email address Ex: youremail@gmail.com

  • Auth Password: Your Gmail password

M3 service

  • Host: m3 host url Ex - v2010004s.m3xs.net

  • Port: 587

  • Auth User: Email username account or M3 FTP master account

  • Auth Password: Your email password or M3 FTP master password