Skip to content

Developer Guides

Bùi Nguyễn Tấn Sang edited this page May 12, 2024 · 25 revisions

Neutron Developer Guide

System Requirements

Neutron is designed to run on Windows with a highly compatible and stable environment. It has also been tested for compatibility with Linux. Support for additional environments will be added in future updates.

Software Requirements

To ensure proper functionality, Neutron requires Python 3.12.1.

Dependent Packages

Neutron relies on the following Python packages, which can be installed using pip:

python -m pip install -r requirements.txt
  • mysql-connector-python
  • python-dotenv
  • Flask-Babel
  • langdetect
  • wikipedia
  • waitress
  • sendgrid
  • markdown
  • gunicorn
  • requests
  • pymysql
  • flask
  • bs4 (Beautiful Soup)

API Integration

Google Safe Browsing API

Neutron utilizes the Google Safe Browsing API for enhancing security features. Please refer to the Google Safe Browsing API Documentation for guidelines on obtaining the required API key.

Sendgrid API

For enabling email functionality within Neutron, you'll need to create a Sendgrid account and obtain an API key from Sendgrid.

reCAPTCHA API

For reCAPTCHA to work you need to have the necessary keys, you can get it here.

Config

To configure Neutron's APIs/MySQL, follow these steps:

  1. Access ADPN (Admin Panel) by following the instructions in the ADPN (Admin Panel) Guides.

  2. Use the config command inside ADPN to configure the required information for Neutron.

By following these instructions, you'll have the necessary environment set up to develop Neutron effectively. Remember to securely manage your information and reach out for further assistance or clarification if needed.