Included in this guide:
You can deploy the app on Heroku by clicking the button below:
If you don't have a Heroku account, you will be prompted to create one.
The following free add-ons are automatically installed as part of set-up. Even though the add-ons are free, you have to verify your account by adding a credit card.
- PostgreSQL is the database for your application.
- PG Backups creates backups of your database.
- SendGrid sends emails from your application (e.g. the forgot password email).
- NewRelic monitors your application performance
- Cloudinary resizes, crops and then stores the images in your application.
During setup, you will be prompted to enter a EMAIL_REDIRECT_HOST, used within the emails sent from your application. The value should be YOURAPPNAME.herokuapp.com
First, go to your Heroku account and create an application to be used for the project. When asked for the number of web dynos to be used in your application select 2. There is a small monthly fee associated with having an extra dyno.
For testing purposes, you can choose an application with no extra dynos (this will be free). Please note that sites with no extra dynos "go to sleep" and can be slow to wake up. So, when you are ready to let the public use your site, make sure that your Heroku appliation has at least 2 dynos.
Your site was installed with a default username and password (these are set in the db/seeds.rb file). Go to your app and login
http://YOURAPPNAME.herokuapp.com/cms
The default username and password are:
admin@example.com
password
Once you login, use the Admin menu in the navigation to change the email to your email address. Then you will need to change the password to a strong password that only you know.
In most cases you will not need to setup a development environment for this application. The only reason to go through the following steps would be if you wanted to customize your site beyond what you can set with the Content Editor.
To setup the application you will need:
- PostgreSQL database
- Ruby 1.9.3-p448
- Bundler gem
- Bower
$ sudo apt-get -y install postgresql
$ brew install postgresql
To install ruby, it is necessary to have rbenv installed. This can be installed following the steps described in rbenv's Github Repository, in the Installation Section.
When rbenv is already installed, go to the project's root folder, and run the following command
$ rbenv installIn order the manage the project dependencies, it is necessary to have installed bundler.
$ gem install bundlerTo manage the client-side js dependencies, it is necessary to have installed bower. Bower depends on node.js, so if it is not installed yet, install it with nvm, following these instructions: NVM - Installation guide.
Having node.js installed, run the following command to install bower:
npm install -g bowerBefore running the app, the following steps should be performed.
- Obtain a copy of the application
- Create the database user for the application
- Install the application dependencies
- Create the database
- Download the client-side dependecies
Clone the code to your computer. The command you type into your shell application (Terminal on the Mac) will be:
$ git clone https://github.com/city72/city-72.gitThis will create a directory named city-72.
createuser -P -s city72Assign the word city72 as password too.
Linux users should run the above command as postgres user (sudo su postgres).
bundle installbundle exec rake db:setupbower installWith all the prerequisites and the development environment ready. Just run the app, with the following command:
bundle exec rails sGo to your browser and open
localhost:3000