SmartScript

Requirements

• Node Package Manager
• Node.js
• ReactJS
• Python 3.6
  • Anaconda to install python and python modules as described in setup

Project Notes

Pertinent high-level information about the project

Setup

• To install Javascript packages, to to root folder, and write npm install. this will install the ReactJS and Node.js modules that used in SmartScript.
• To install Python packages:
  1. install Anaconda
  2. conda create -n env_name --file req.txt
  3. conda activate env_name
  • env_name - the name of the desire enviorment (eg: py36, etc...)

Front-end Compiling

To compile the front end:

1. Go to root folder.
2. npm run build - will build and compile admin frontend and user frontend

Running SmartScript

Files & directories

List of key files and directories, how they're organized and used, etc.

Hacks/Kludges

1. Hack/kludge name Short description of what was done and why, including any reference links

   • When: date

   • File(s):

     • Line #N in [path to file]
     • Line #N in [path to file]

   • Database: Note any changes to the database. If none, delete this line.

Design Notes

If needed, pertinent design notes

Credits

Kinda obvious, no? ;)