emis_developer_manual
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
emis_developer_manual [2023/02/20 21:51] – [Install the frontend dependencies] ghachey | emis_developer_manual [2023/07/06 18:24] (current) – [Loading the Solution into Visual Studio] ghachey | ||
---|---|---|---|
Line 63: | Line 63: | ||
There is no need for an expensive license, the Express edition which is freely available will work fine for most small countries. If you don't have already a commercial license download the free version [[https:// | There is no need for an expensive license, the Express edition which is freely available will work fine for most small countries. If you don't have already a commercial license download the free version [[https:// | ||
+ | |||
+ | The following databases distributed with the source code in the folder databases: | ||
+ | |||
+ | * **IdentifiesP.bak**: | ||
+ | * **pacificemisdb.bak**: | ||
+ | * **pacificemisdb-withsamplelookups.bak**: | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | Restoring a database from a backup is documented [[https:// | ||
==== Programming Language ==== | ==== Programming Language ==== | ||
Line 97: | Line 107: | ||
- Download and install [[https:// | - Download and install [[https:// | ||
- | - Download and install | + | - Download and install [[https:// |
- | - Download and install [[https:// | + | - Download and install [[https:// |
- Download and install latest [[https:// | - Download and install latest [[https:// | ||
- | - Download and install most recent version 16 LTS [[https:// | + | - Download and install most recent version 16 LTS [[https:// |
- Install Bower from the command line you can simply ''> | - Install Bower from the command line you can simply ''> | ||
- Install Grunt from the command line you can simply ''> | - Install Grunt from the command line you can simply ''> | ||
- Download and install [[https:// | - Download and install [[https:// | ||
+ | <note important> | ||
==== Software Configuration Management ==== | ==== Software Configuration Management ==== | ||
Line 167: | Line 177: | ||
{{ : | {{ : | ||
- | You can then verify if VS is actually using the node and npm binaries you think they were by opening **Tools - NuGet Package Manager - Package Manager Console** and typing the following commands and observing the output. | + | You can then verify if VS is actually using the node and npm binaries you think they were by opening **Tools - NuGet Package Manager - Package Manager Console** and typing the following commands and observing the output. The version should be the one you installed manually above (and not the one in the screenshot). |
{{ : | {{ : | ||
Line 173: | Line 183: | ||
</ | </ | ||
- | Try to build the solution. At first, | + | As a one time thing, you need to set/verify the starting project of the solution. |
+ | |||
+ | At this point if you followed closely the previous sections you should already be able to right click on the **Solution ' | ||
+ | |||
+ | You should then try running | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | If you do not yet see the Task Runner Explorer window | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | |||
+ | ==== Application Configuration ==== | ||
+ | |||
+ | The main configuration for the application is the file '' | ||
+ | |||
+ | You will need to setup two databases: the Identity database (i.e. IdentitiesP) and the application' | ||
+ | |||
+ | Replace '' | ||
+ | |||
+ | <code xml> | ||
+ | <add name=" | ||
+ | </ | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | <add key=" | ||
+ | <add key=" | ||
+ | <add key=" | ||
+ | <add key=" | ||
+ | ... | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | There are other appSettings less critical but important for some functionalities. | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | ... | ||
+ | <!-- The report server configuration for the reporting functionality --> | ||
+ | <add key=" | ||
+ | <add key=" | ||
+ | <add key=" | ||
+ | <add key=" | ||
+ | ... | ||
+ | <!-- The location where files are stored on the computer used by a number of features in the system --> | ||
+ | <add key=" | ||
+ | ... | ||
+ | <!-- Emailing functionality cnofiguration --> | ||
+ | <add key=" | ||
+ | <add key=" | ||
+ | <!-- use the your own email if you want to test receiving systems emails (e.g. errors notifications) --> | ||
+ | <add key=" | ||
+ | <!-- use the bc for testing, so that a copy of all outbound emails is sent to this address --> | ||
+ | < | ||
+ | ... | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | And finally, for email notifications to work it must be configured to use a email server. Various approaches can be used, perhaps the easiest is to use a Gmail account with an application password. | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | < | ||
+ | <!-- settings for email delivery using smtp client | ||
+ | will vary according to the sender - refer to sysadmin docs at | ||
+ | http:// | ||
+ | <!-- Using a Google account is an easy and reliable way. | ||
+ | this may require that you " | ||
+ | be enabled for the Gmail account used by the NetworkCredential | ||
+ | see https:// | ||
+ | <smtp deliveryMethod=" | ||
+ | <network host=" | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | ==== Running the Solution ==== | ||
+ | |||
+ | At this point you should be ready to run the system by clicking on the following. Note that below was first set to Google Chrome but it could be started within any browser. | ||
+ | |||
+ | {{ : | ||
- | TODO | ||
==== [Optional] Various Visual Studio Configuration ==== | ==== [Optional] Various Visual Studio Configuration ==== | ||
Line 218: | Line 312: | ||
* **Tabify Selected Lines** - converts leading spaces to tabs. Respects the tab size setting in **Tools - Options** when making this conversion. It is recommended to run this on files before submitting a commit. | * **Tabify Selected Lines** - converts leading spaces to tabs. Respects the tab size setting in **Tools - Options** when making this conversion. It is recommended to run this on files before submitting a commit. | ||
* **View White Space** - toggle display spaces and tabs (CTRL-E,S) | * **View White Space** - toggle display spaces and tabs (CTRL-E,S) | ||
- | |||
- | |||
- | ==== Databases Setup ==== | ||
- | |||
- | You will need to setup two databases: the application' | ||
- | |||
- | Restoring a database from a backup is documented [[https:// | ||
- | |||
- | In VS, open the file '' | ||
- | |||
- | <code xml> | ||
- | <add name=" | ||
- | </ | ||
- | |||
- | And replace '' | ||
- | |||
- | <code xml> | ||
- | < | ||
- | <add key=" | ||
- | <add key=" | ||
- | <add key=" | ||
- | <add key=" | ||
- | <add key=" | ||
- | </ | ||
- | </ | ||
- | |||
- | And replace '' | ||
- | |||
- | ==== Building the Solution ==== | ||
- | |||
- | First, as a one time thing, you need to set the starting project of the solution. Right click on the **Pineapples** project in the **Solution Explorer** and click on **Set as StartUp project**. The Pineapples project should from now on become bold. | ||
- | |||
- | At this point if you followed closely the previous sections you should already be able to right click on the **Solution ' | ||
- | |||
- | You should then try running the grunt task _build_deploy as shown below. Run it a couple of times for good measure. | ||
- | |||
- | {{ : | ||
- | |||
- | At this point you should be ready to run the system by clicking on the following. Note that below was first set to Google Chrome but it could be started within any browser. | ||
- | |||
- | {{ : | ||
- | |||
- | |||
==== Troubleshooting Visual Studio Build/Run Errors ==== | ==== Troubleshooting Visual Studio Build/Run Errors ==== |
emis_developer_manual.1676929913.txt.gz · Last modified: 2023/02/20 21:51 by ghachey