-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.html
205 lines (190 loc) · 16.3 KB
/
readme.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>cloudscribe New Project</title>
<link href="https://ajax.aspnetcdn.com/ajax/bootstrap/3.3.1/css/bootstrap.min.css" rel="stylesheet" />
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet" />
</head>
<body>
<div id="main" class="container body-content" role="main">
<a href="https://www.cloudscribe.com?utm_source=projecttemplate&utm_medium=referral&utm_campaign=newproject-pgsql">
<img alt="cloudscribe"
class="img-responsive"
src="https://www.cloudscribe.com/campaignimages/projectreadmeheader.png?utm_source=projecttemplate&c=Offsite-Interactions&a=Project-Created&m=7&d=4&dl=newproject-pgsql&cb=1424E2E5-58AA-4925-B832-3FA53D4D4D82">
</a>
<section>
<h2>Thanks for starting your project with cloudscribe!</h2>
<p>Here are some informative tips to help you get started.</p>
<p>We would really appreciate it if you would <a target="_blank" href="https://www.cloudscribe.com/account/register?utm_source=projecttemplate&utm_medium=referral&utm_campaign=newproject-pgsql">Register on cloudscribe.com</a>
if you haven't already, and be sure to checkout the <a target="_blank" href="https://www.cloudscribe.com/docs?utm_source=projecttemplate&utm_medium=referral&utm_campaign=newproject-pgsql">Documentation</a>.
You can also ask questions in our <a target="_blank" href="https://gitter.im/joeaudette/cloudscribe">gitter chat web page</a>.</p>
<p>If you like cloudscribe and our Visual Studio project template, please give us a good review in
<a target="_blank" href="https://marketplace.visualstudio.com/items?itemName=joeaudette.cloudscribeProjectTemplate">the Visual Studio Marketplace</a></p>
<p>Follow <a target="_blank" href="https://twitter.com/cloudscribeweb">@cloudscribeweb</a> and <a target="_blank" href="https://twitter.com/joeaudette">@joeaudette</a> on Twitter!</p>
<article>
<h3><span aria-hidden="true" class="fa fa-check"></span> Next Steps</h3>
<ul class="list-group">
<li class="list-group-item">
<strong>Update to the latest cloudscribe NuGet packages</strong> -
It is always a good idea to use the latest cloudscribe NuGet packages.
Right click the solution node and choose "Manage NuGet Packages for Solution", then check for any available updates.
</li>
<li class="list-group-item">
<strong>Set your PostgreSql Connection string.</strong>
You should copy the connection string from appsettings.json into appsettings.Development.json and set it to a valid connection string
for PostgreSql using the format shown in appsettings.json. If your project is under source control such as git, you should add the
appsettings.Development.json file to your .gitignore file so it won't be committed to source control.
</li>
<li class="list-group-item">
<strong>Login Credentials</strong>
When you first run the project application an administrative user account will be created automatically with the email [email protected]
and the password admin. Once you login with administrative permissions a new Administration menu will appear, you should take a look around
the various menu items to find the configurable settings that are of interest to you. One of the first things you should do is change the email
address and password of the admin user account. You can change the email under Administration > User Management > User List.
You can change the password by clicking the welcome user message at the top of the page. Be careful not to forget your password at least until
you have configured SMTP settings for email because password reset emails can't be sent until you do that.
If you deploy the application to public facing web hosting be sure to change these credentials immediately after deployment.
</li>
<li class="list-group-item">
<strong>Data Protection</strong>
Be sure to see the comments in Startup.cs about data protection and how to configure the storage location of data protection keys.
Data protection keys are used to encrypt some settings that are persisted to data storage such as the password for SMTP, and the "secrets"
for social authentication.
</li>
<li class="list-group-item">
<strong>Configure SMTP Settings for email notifications</strong>
In order for certain features like password reset or requiring a confirmed email to work, your site needs to be able to send email notifications.
You will find settings for this under Administration > Email Settings
</li>
<li class="list-group-item">
<strong>Build your own custom features</strong>
Now that your project is created, you likely have plans to write some code for the custom features you need. cloudscribe doesn't impose
any prescriptive requirements or patterns for how you build your own features, you can typically use any patterns and approaches
that you would normally use in ASP.NET Core. But there is some guidance provided for getting the current user information and how to
optionally implement multi-tenancy in your own features if you need that.
See the <a href="https://www.cloudscribe.com/docs/building-custom-features-that-integrate-with-cloudscribe-core?utm_source=projecttemplate&utm_medium=referral&utm_campaign=newproject-pgsql">Building Custom Features Documentation</a>
for more information.
</li>
<li class="list-group-item">
<strong>Create a Custom theme</strong>
There are a bunch of bootswatch themes included and you can choose the theme from a dropdown list under Administration > Site Settings after you login to your project.
But more than likely you will want to create a custom theme.
See the <a href="https://www.cloudscribe.com/docs/themes-and-web-design?utm_source=projecttemplate&utm_medium=referral&utm_campaign=newproject-pgsql">Themes and Web Design</a>
documentation for more information.
</li>
<li class="list-group-item">
<strong>Configuration Sources</strong>
By default, the configuration system will let you override appsettings.json from appsettings.Development.json when the environment is Development.
I would avoid putting any sensitive information directly in appsettings.json because you will likely want to include that file in source control.
You can copy any settings from appsettings.json into appsettings.Development.json instead of putting anything sensitive in appsettings.json.
I generally add appsettings.Development.json to my .gitignore file so that any connection strings or credentials I put there won't go into source control.
It also supports overriding appsettings.json with appsettings.Production.json if the environment is Production. We don't include an
appsettings.Production.json file in the template, I usually would create that file manually on the production server as part of my first deployment.
For Azure hosting you would generally use Environment Variables or Azure Key Vault as discussed in the
<a href="https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration?tabs=basicconfiguration">official documentation</a>.
</li>
<li class="list-group-item">
<strong>Google Analytics</strong>
There is built in support for google analytics, you just add your profile id under Administration > Site Settings.
There is also tracking of account activities such as site registration and logins, including social login tracking.
To get the most benefit from google analytics, see the <a href="https://www.cloudscribe.com/docs/google-analytics-integration?utm_source=projecttemplate&utm_medium=referral&utm_campaign=newproject-pgsql">documentation</a>.
</li>
</ul>
</article>
<div class="row">
<div class="col-md-12">
<h2>Support cloudscribe by Buying Swag at Our CafePress Shop!</h2>
<p>I've invested a lot of unpaid time and effort to make cloudscribe available and to keep improving it.
I really appreciate anything you can do to support my work, please help spread the word and encourage others to try
cloudscribe, and if you can spare a few bucks for a t-shirt or a voluntary payment I would be grateful.</p>
<p>See all the available merchandise on our <a href="http://www.cafepress.com/cloudscribe">CafePress shop!</a>
We make about $5 on each item and you can help us spread awareness of cloudscribe with our branded products.
Only a few of our branded items are shown below.
</p>
</div>
</div>
<div class="row">
<div class="col-md-4">
<a href="http://www.cafepress.com/cloudscribe.81640156"><img src="https://www.cloudscribe.com/img/cloudscribewww_tshirt.jpg" /></a>
</div>
<div class="col-md-4">
<a href="http://www.cafepress.com/cloudscribe.81640151"><img src="https://www.cloudscribe.com/img/cloudscribewww_sweatshirt.jpg" /></a>
</div>
<div class="col-md-4">
<a href="http://www.cafepress.com/cloudscribe.81640150"><img src="https://www.cloudscribe.com/img/cloudscribe-mug-cp.png" /></a>
</div>
</div>
<div class="row">
<div class="col-md-12">
<h2>Make a Voluntary Payment to Say Thanks!</h2>
<div class="col-md-3 donate-button">
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
<input type="hidden" name="cmd" value="_s-xclick">
<input type="hidden" name="hosted_button_id" value="LRTXQVNQWWJWU">
<table>
<tr><td><input type="hidden" name="on0" value="Support My Work">Support My Work</td></tr>
<tr>
<td>
<select name="os0">
<option value="Good will contribution">Good will contribution $25.00 USD</option>
<option value="I really benefited from your work">I really benefited from your work $50.00 USD</option>
<option value="I'm really getting a lot of value from your work!">I'm really getting a lot of value from your work! $100.00 USD</option>
</select>
</td>
</tr>
</table>
<input type="hidden" name="currency_code" value="USD">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_paynowCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
</form>
</div>
<div class="col-md-3 donate-button">
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
<input type="hidden" name="cmd" value="_s-xclick">
<input type="hidden" name="hosted_button_id" value="DHASFB2BGS5UY">
<table>
<tr><td><input type="hidden" name="on0" value="Beer Donation">Beer Donation</td></tr>
<tr>
<td>
<select name="os0">
<option value="Buy Me a Pint of Beer!">Buy Me a Pint of Beer! $5.00 USD</option>
<option value="Buy Me a 6 Pack!">Buy Me a 6 Pack! $15.00 USD</option>
<option value="Buy Me a Case of Beer!">Buy Me a Case of Beer! $25.00 USD</option>
</select>
</td>
</tr>
</table>
<input type="hidden" name="currency_code" value="USD">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_paynowCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
</form>
</div>
<div class="col-md-3 donate-button">
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
<input type="hidden" name="cmd" value="_s-xclick">
<input type="hidden" name="hosted_button_id" value="AGPRQQBGPGKYN">
<table>
<tr><td><input type="hidden" name="on0" value="Coffee Donation">Coffee Donation</td></tr>
<tr>
<td>
<select name="os0">
<option value="Buy Me a Cup of Coffee!">Buy Me a Cup of Coffee! $5.00 USD</option>
<option value="Buy Me Breakfast!">Buy Me Breakfast! $15.00 USD</option>
<option value="Buy Me a Week of Coffee!">Buy Me a Week of Coffee! $25.00 USD</option>
</select>
</td>
</tr>
</table>
<input type="hidden" name="currency_code" value="USD">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_paynowCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
</form>
</div>
</div>
</div>
</section>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script src="https://ajax.aspnetcdn.com/ajax/bootstrap/3.3.1/bootstrap.min.js"></script>
</body>
</html>