You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<li><ahref="#installing-browsercms">Installing BrowserCMS</a><ul><li><ahref="#things-you-need-first">Things you need first</a></li></ul></li><li><ahref="#trying-out-browsercms">Trying out BrowserCMS</a><ul><li><ahref="#your-first-project">Your first project</a></li><li><ahref="#using-your-site">Using your Site</a></li></ul></li><li><ahref="#starting-a-real-project">Starting a ‘Real’ project</a><ul></ul></li><li><ahref="#the-really-short-version">The really short version</a><ul></ul></li><li><ahref="#getting-command-line-help">Getting Command line Help</a><ul></ul></li><li><ahref="#deploying-to-production">Deploying to production</a><ul></ul></li></ol></div>
130
+
<li><ahref="#this-guide-assumes">This Guide Assumes</a><ul></ul></li><li><ahref="#starting-a-demo-project">Starting a demo project</a><ul><li><ahref="#installing-browsercms">Installing BrowserCMS</a></li><li><ahref="#creating-a-demo-website">Creating a Demo Website</a></li><li><ahref="#using-your-site">Using your Site</a></li></ul></li><li><ahref="#starting-a-real-project">Starting a ‘Real’ project</a><ul></ul></li><li><ahref="#the-short-command">The short command</a><ul></ul></li><li><ahref="#getting-command-line-help">Getting Command line Help</a><ul></ul></li><li><ahref="#trouble-shooting">Trouble Shooting</a><ul><li><ahref="#creation-fails-to-create-mysql-database">Creation fails to create MySQL Database</a></li></ul></li><li><ahref="#deploying-to-production">Deploying to production</a><ul></ul></li></ol></div>
131
131
</td>
132
132
<tdclass="guides">
133
133
<h2>Getting Started</h2>
@@ -137,25 +137,28 @@ <h2>Getting Started</h2>
137
137
<li>Create a demo project to explore BrowserCMS</li>
138
138
<li>Create a blank project for building a website from scratch</li>
<p>BrowserCMS is packaged as a gem which can be included in any Rails project. The gem contains the code for the cms application itself, as well as public assets, including stylesheets, images and javascript. These assets will be copied from the gem into your project as part of the install process.</p>
142
-
<p>The gem is hosted at Gemcutter, so you can install it by doing:</p>
<li>The <ahref="http://rubyonrails.org/download">Rails</a> framework (2.3 or later – But not 3.0 yet)</li>
146
+
<li>A working installation of <ahref="http://www.sqlite.org/">SQLite</a> or <ahref="http://www.mysql.com/">MySQL</a> as well as the gems for your database of choice.</li>
149
147
</ol>
150
-
<h3id="trying-out-browsercms">2 Trying out BrowserCMS</h3>
151
-
<p>This section will cover how to create a demo project using BrowserCMS, so you can play around with it. It will create a sample project, with some pages and content to play around with.</p>
152
-
<h4id="your-first-project">2.1 Your first project
153
-
BrowserCMS</h4>
148
+
<h3id="starting-a-demo-project">2 Starting a demo project</h3>
149
+
<p>This section of the guide will cover creating a sample website with BrowserCMS, using a demo website layout and content.
150
+
The goal is to give you some content and templates to play with to explore the <spanclass="caps">CMS</span>. Later sections of this guide will
151
+
cover the more common cases where you are creating a new website from scratch and want only the bare minimums.</p>
<p>By default, Rails assumes that if you do not specify a -d flag, that you want to use SQLite as your project’s database. You need to have the sqlite3-ruby gem installed for this to work.</p>
158
-
<h4id="using-your-site">2.2 Using your Site</h4>
160
+
<p>This will create a BrowserCMS project which used SQLite as the data storage. You need to have the sqlite3-ruby gem installed for this to work.</p>
161
+
<h4id="using-your-site">2.3 Using your Site</h4>
159
162
<p>Open your browser to <ahref="http://localhost:3000/cms">http://localhost:3000/cms</a> to log into the admin for the <spanclass="caps">CMS</span>. Enter the default username/password (in development mode) is username=cmsadmin, password=cmsadmin. You should be now be logged in, viewing the home page of the site. You can now edit or add new content via the admin interface.</p>
160
163
<p>To learn more about the types of things you can do with BrowserCMS, see the <ahref="user_guide.html">User’s Guide</a>.</p>
161
164
<h3id="starting-a-real-project">3 Starting a ‘Real’ project</h3>
@@ -170,16 +173,24 @@ <h3 id="starting-a-real-project">3 Starting a ‘Real’ project</h3>
170
173
the database, migrate the db, populate it with the bare minimum content it needs, and copy all of the necessary files
171
174
from the gem into the rails project. Open your browser to <ahref="http://localhost:3000/cms">http://localhost:3000/cms</a> to log in,
172
175
using cmsadmin/cmsadmin as the username/password.</p>
173
-
<h3id="the-really-short-version">4 The really short version</h3>
174
-
<p>There is a shorter version of the commandline script, which works identically to the longer form detailed above.</p>
176
+
<h3id="the-short-command">4 The short command</h3>
177
+
<p>There is a shorter version of the command line script, which works identically to the longer form detailed above.</p>
<p>This will show common usages, as well as all the help options available. The <tt>browsercms</tt> command piggybacks on top of the
181
184
<tt>rails</tt> command, so many of the options available are the same as <tt>rails</tt>, including <tt>-f</tt> or <tt>--force</tt>.</p>
182
-
<h3id="deploying-to-production">6 Deploying to production</h3>
185
+
<h3id="trouble-shooting">6 Trouble Shooting</h3>
186
+
<p>This section covers some potential problems you might run into when trying to create a BrowserCMS project.</p>
187
+
<h4id="creation-fails-to-create-mysql-database">6.1 Creation fails to create MySQL Database</h4>
188
+
<p>BrowserCMS will attempt to create and populate the database. When running against mysql, Rails will assume you have a username called <tt>root</tt> with an empty password.
189
+
The database create/migrations will fail if you don’t have that username/password set. If this occurs, you can update the config/database.yml with correct username/password
190
+
and rerun the <tt>bcms</tt> command which will regenerate the entire project.</p>
191
+
Choose ‘n’ (No) when it prompts you to overwrite the config/database.yml and then ‘a’ (Overwrite all) for all files after that.
192
+
This should complete the project generation using the new username/password.
193
+
<h3id="deploying-to-production">7 Deploying to production</h3>
183
194
<p>Once you get ready to start deploying your application into production environments, be sure to review the <ahref="deployment_guide.html">Deployment Guide</a>.
184
195
There are several ‘gotchas’ to be aware of that may differ from deploying other Rails applications.</p>
Copy file name to clipboardExpand all lines: doc/guides/source/getting_started.textile
+35-18
Original file line number
Diff line number
Diff line change
@@ -4,41 +4,44 @@ The purpose of this guide is help new developers get up and running with Browser
4
4
5
5
* Install the BrowserCMS gem
6
6
* Create a demo project to explore BrowserCMS
7
-
* Create a blank project for building a website from scratch
7
+
* Create a blank project for building a website from scratch
8
8
9
9
endprologue.
10
10
11
-
h3. Installing BrowserCMS
11
+
h3. This Guide Assumes
12
12
13
-
BrowserCMS is packaged as a gem which can be included in any Rails project. The gem contains the code for the cms application itself, as well as public assets, including stylesheets, images and javascript. These assets will be copied from the gem into your project as part of the install process.
13
+
Before you can create a project using BrowserCMS, you will need to have the following installed.
14
14
15
-
The gem is hosted at Gemcutter, so you can install it by doing:
15
+
# The "Ruby":http://www.ruby-lang.org/en/downloads Language
16
+
# The "RubyGems":http://rubyforge.org/frs/?group_id=126 packaging system
17
+
# The "Rails":http://rubyonrails.org/download framework (2.3 or later - But not 3.0 yet)
18
+
# A working installation of "SQLite":http://www.sqlite.org/ or "MySQL":http://www.mysql.com/ as well as the gems for your database of choice.
16
19
17
-
<shell>
18
-
$ sudo gem install browsercms
19
-
</shell>
20
+
h3. Starting a demo project
20
21
21
-
h4. Things you need first
22
+
This section of the guide will cover creating a sample website with BrowserCMS, using a demo website layout and content.
23
+
The goal is to give you some content and templates to play with to explore the CMS. Later sections of this guide will
24
+
cover the more common cases where you are creating a new website from scratch and want only the bare minimums.
22
25
23
-
Before you can create a project using BrowserCMS, you will need to have the following installed.
26
+
h4. Installing BrowserCMS
24
27
25
-
# *Rails 2.3* (or later) - We make use of some of the newer features from Rails like application generator templates.
26
-
# *A Database* - Either Mysql or the Sqlite gems should be installed.
28
+
BrowserCMS is packaged as a gem which can be included in any Rails project. To install the gem, do the following:
27
29
28
-
h3. Trying out BrowserCMS
30
+
<shell>
31
+
$ gem install browsercms
32
+
</shell>
29
33
30
-
This section will cover how to create a demo project using BrowserCMS, so you can play around with it. It will create a sample project, with some pages and content to play around with.
34
+
h4. Creating a Demo Website
31
35
32
-
h4. Your first project
33
-
BrowserCMS
36
+
Run the following from your terminal window.
34
37
35
38
<shell>
36
39
$ browsercms project_name -m demo
37
40
$ cd project_name
38
41
$ script/server
39
42
</shell>
40
43
41
-
By default, Rails assumes that if you do not specify a -d flag, that you want to use SQLite as your project's database. You need to have the sqlite3-ruby gem installed for this to work.
44
+
This will create a BrowserCMS project which used SQLite as the data storage. You need to have the sqlite3-ruby gem installed for this to work.
42
45
43
46
h4. Using your Site
44
47
@@ -65,9 +68,9 @@ the database, migrate the db, populate it with the bare minimum content it needs
65
68
from the gem into the rails project. Open your browser to "http://localhost:3000/cms":http://localhost:3000/cms to log in,
66
69
using cmsadmin/cmsadmin as the username/password.
67
70
68
-
h3. The really short version
71
+
h3. The short command
69
72
70
-
There is a shorter version of the commandline script, which works identically to the longer form detailed above.
73
+
There is a shorter version of the command line script, which works identically to the longer form detailed above.
71
74
72
75
<shell>
73
76
$ bcms project_name -d mysql
@@ -86,6 +89,20 @@ $ browsercms
86
89
This will show common usages, as well as all the help options available. The +browsercms+ command piggybacks on top of the
87
90
+rails+ command, so many of the options available are the same as +rails+, including +-f+ or +--force+.
88
91
92
+
h3. Trouble Shooting
93
+
94
+
This section covers some potential problems you might run into when trying to create a BrowserCMS project.
95
+
96
+
h4. Creation fails to create MySQL Database
97
+
98
+
BrowserCMS will attempt to create and populate the database. When running against mysql, Rails will assume you have a username called +root+ with an empty password.
99
+
The database create/migrations will fail if you don't have that username/password set. If this occurs, you can update the config/database.yml with correct username/password
100
+
and rerun the +bcms+ command which will regenerate the entire project.
101
+
102
+
Choose 'n' (No) when it prompts you to overwrite the config/database.yml and then 'a' (Overwrite all) for all files after that.
103
+
This should complete the project generation using the new username/password.
104
+
105
+
89
106
h3. Deploying to production
90
107
91
108
Once you get ready to start deploying your application into production environments, be sure to review the "Deployment Guide":deployment_guide.html.
0 commit comments