Before you begin reading this document, throw your pillows off and get these tools installed on your PC first:
- Visual Studio 2015 Community
- PostgreSQL Server 9.3+ or SQL Server 2014+
- Git for Windows
- TortoiseGit (if you want a nice Git GUI)
Once you have all of the above, you're good to go.
Please do not download github repository as a ZIP file. Use git to clone frapid.
Using Git (Optional)
Run Git Bash console application.
mkdir frapid
cd frapid
git clone https://github.com/frapid/frapid
OR
Tortoise Git (Optional)
- Using Windows Explorer, navigate to the directory where you want to keep frapid source codes on.
- Right mouse click and then click Git Clone.
- On the URL field, type
https://github.com/frapid/frapid. - Click OK.
Once you finish this step, you have a local frapid git repository on your hard drive.
Rename (or copy) the directory ~/Resources/_Config to ~/Resources/Config.
Configuration enables you to customize application behaviors whereas convention forces you to follow and keep track of things. Frapid uses the best of both worlds.
The root directory of frapid web application is:
~/src/Frapid.Web
The master configuration files are available on the ~/Resources/Configs directory.
| File Name | Description |
|---|---|
| DomainsApproved.json | Contains list of approved DNS domain names which will be served by Frapid. |
| DomainsInstalled.json | Contains list of installed DNS domain names. This file should not be edited manually. |
| JwtConfig.json | Contains configuration related to Json Web Tokens. |
| Parameters.config | Contains standard application configuration data. |
| PostgreSQL.config | Contains configuration realted your PostgreSQL server. |
| RblServers.config | Contains list of RBL (DNS Blacklist) Servers. |
| RedisConfig.json | Contains Redis server configuration. |
| SQLServer.config | Contains configuration realted your SQL Server. |
You must be fairly familiar with the master configuration files before you proceed to the next steps.
Configuration in frapid is instance-aware. It is, therefore, safe to assume that configuration of foo.com does not affect bar.com.
By convention, the configuration files for foo.com would be located on:
~/Tenants/foo_com/Configs
| File Name | Description |
|---|---|
| Areas | Contains module specific configuration and overrides for foo_com instance. |
| Attachments | Attachments (uploads) of foo_com instance. |
| Backups | Backups of foo_com instance |
| Configs | Configuration files related to foo_com instance. More on this topic is discussed below. |
| Documents | Documents related to foo_com instance. |
| File Name | Description |
|---|---|
| Applications.config | Contains configuration of frapid applications related to foo_com instance. |
| SMTP\SendGrid.json | Contains configuration of SendGrid Transactional Email Service related to foo_com instance. |
| SMTP\Mailgun.json | Contains configuration of Mailgun Transactional Email Service related to foo_com instance. |
By convention, website themes would be found on:
~/Tenants/foo_com/Areas/Frapid.WebsiteBuilder/Themes/<ThemeName>
Read more on the chapter Creating Website Themes.
Now that you have gone through this document completely, you now have a proper understanding of what's going under the hoods.
Please follow the IIS Installation Guide to install frapid on your development machine.