Add instructions to setup PostgreSQL #251

mzeleniuk · 2016-12-15T10:42:32Z

When generated a new Hanami project with PostgreSQL I was a bit confused how to setup a database on my local machine (I was not able to start hanami server because of database connection error). It's not well documented yet so I spend some time to find the answer.
I'm not sure where is the best place to show the setup instructions but I hope it will be helpful for new Hanami users.
Particularly closes #229.
Cheers!

TiteiKo · 2016-12-15T11:58:32Z

Hi @mzelenyuk and thank you for the time spent on this!

As I said in the issue, I think it should be a full guide page, detailing the configuration for the 3 mainly used DBs. The Getting Started guide should stay clear of this, and only have a link to the previously mentioned Guide.

Do you think you'd have time to make a new guide page and adapt what you wrote here as a section of that guide?

mzeleniuk · 2016-12-15T13:42:14Z

Hi @TiteiKo! Yeah, I think a new Guide page for database configuration is the best case.
And sure, I'm able to do it if you'll help me with its title (I assume the "Database configuration" will be fine, what do you think?) and placement in right navigation list.

TiteiKo · 2016-12-15T13:45:16Z

I'm not the best to answer this, so I'll let the amazing people of @hanami/documentation answer your questions!

mzeleniuk · 2016-12-15T13:50:12Z

@TiteiKo Great, thanks!

davydovanton · 2016-12-16T10:55:47Z

@mzelenyuk good idea 👍
But I think we need to create this section is more general (not only for psql DB).

What do you think, maybe will better to write something like this?

Before starting your server, you need to configure DB link in .env* files.
Open this file for each environment and update DB_URL for your DB.
For example, for psql, you need to do this and this ...

/cc @cllns

mzeleniuk · 2016-12-16T13:40:24Z

@davydovanton Sounds good. We may consider to place each DB's specific content under its own header (see screenshot) and tell how to create a table for each environment to make database setup more easier for the beginners.

davydovanton · 2016-12-16T14:03:50Z

@mzelenyuk awesome 👍

mzeleniuk · 2016-12-16T14:10:18Z

@davydovanton Thanks! So what's the plan now? Waiting for @cllns response?

davydovanton · 2016-12-16T14:36:54Z

yep :)

cllns · 2016-12-16T16:13:14Z

Yes, I think this should be its own guide, not a part of the Getting Started guide.

We also have a Environment Variables guide planned, but I don't think people would know to look their for database configuration/info.

I think this should go under the 'Models' section.

jodosha · 2016-12-17T11:51:11Z

@mzelenyuk Hi and thanks for this PR.

TL;DR: We can merge this PR to help new people confused by Postgres complexity, but in the long run we should use Sqlite for the getting started guide.

The less details we present in the getting started guide, the less we overwhelm newcomers.

While having an env vars guide is desirable as reference, we should remove env vars from the getting started guide.

To solve the problem that @mzelenyuk ran into, we should abandon Postgres in the getting started guide in favor of Sqlite. There are a few advantages:

Sqlite is the default database when we generate a new project (hanami new bookshelf)
Postgres is great, but we don't use its powerful features in the getting started guide
Sqlite doesn't require developer's attention to fiddle with env vars and check if a server is running.

TiteiKo · 2016-12-17T14:22:49Z

@jodosha The getting started guide already uses sqlite, see #238

mzeleniuk · 2016-12-19T10:28:34Z

Done (see attached screenshots). By now it has a section only for PostgreSQL. We can add more sections later.
Also before merge may anyone check spelling one more time please? :)

TiteiKo · 2016-12-19T14:13:41Z

source/guides/database-configuration/overview.md

+
+# Overview
+
+Before starting your server, you need to configure database link in <code>.env*</code> files.


configure the database link

TiteiKo · 2016-12-19T14:14:47Z

source/guides/database-configuration/overview.md

+
+## Prepare tables in database
+
+After your database variables setup is done you need to create a table in your database before you're be able to launch a development server.


you need to create the database and run the migrations before being able to launch a development server.

TiteiKo · 2016-12-19T14:15:09Z

source/guides/database-configuration/overview.md

+% bundle exec hanami db prepare
+```
+
+To create a table in database for the test environment, enter:


To setup your test environment database, enter:

TiteiKo · 2016-12-19T14:15:56Z

source/guides/database-configuration/overview.md

+DATABASE_URL="postgres://username:password@localhost/bookshelf_test"
+```
+
+## Prepare tables in database


This could be at the same level of title as Overview

Setup your database

mzeleniuk · 2016-12-19T15:56:09Z

@TiteiKo Fixed. Thanks for help! :)

cllns · 2016-12-19T18:34:06Z

@mzelenyuk Can you rename this Models -> Database Configuration (or something like this, if that's too long for the layout) instead of Database Configuration -> Overview?

DB config only affects Models so I think it fits well in that group :)

mzeleniuk · 2016-12-20T09:11:53Z

@cllns Yes, sure.

jodosha · 2016-12-21T07:46:55Z

@TiteiKo

The getting started guide already uses sqlite, see #238

Wonderful! 💯

jodosha · 2016-12-21T07:47:21Z

@cllns @TiteiKo If you think this is ready, please merge it 😉

TiteiKo · 2016-12-21T18:04:25Z

@cllns Good for me

AlfonsoUceda

Thanks for the PR, once you change these comments I'll be happy to merge ;)

AlfonsoUceda · 2017-01-29T13:11:19Z

source/guides/models/database-configuration.md

+
+```
+# .env.development
+DATABASE_URL="postgres://username:password@localhost/bookshelf_development"


@mzelenyuk could you change postgres:// to postgresql://? We are generating postgresql:// because it supporter in MRI and JRuby ;)

AlfonsoUceda · 2017-01-29T13:11:26Z

source/guides/models/database-configuration.md

+
+```
+# .env.test
+DATABASE_URL="postgres://username:password@localhost/bookshelf_test"


the same here.

mzeleniuk · 2017-01-30T10:18:38Z

@AlfonsoUceda Yes, sure! :)

AlfonsoUceda · 2017-01-30T10:24:44Z

Thanks @mzelenyuk ;)

jodosha assigned cllns Dec 17, 2016

Create Database configuration Guide page

8e6911a

mzeleniuk force-pushed the add-postgresql-setup-instructions branch from 892c615 to 8e6911a Compare December 19, 2016 10:19

TiteiKo reviewed Dec 19, 2016

View reviewed changes

Fix spelling on Database configuration page

c1c1557

Move Database configuration page to Models block

a4aa97b

AlfonsoUceda suggested changes Jan 29, 2017

View reviewed changes

Update DATABASE_URL environment variable for PostgreSQL

3f46d70

AlfonsoUceda approved these changes Jan 30, 2017

View reviewed changes

AlfonsoUceda merged commit 82e7303 into hanami:build Jan 30, 2017

mzeleniuk deleted the add-postgresql-setup-instructions branch January 31, 2017 09:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add instructions to setup PostgreSQL #251

Add instructions to setup PostgreSQL #251

mzeleniuk commented Dec 15, 2016

TiteiKo commented Dec 15, 2016

mzeleniuk commented Dec 15, 2016

TiteiKo commented Dec 15, 2016

mzeleniuk commented Dec 15, 2016

davydovanton commented Dec 16, 2016

mzeleniuk commented Dec 16, 2016

davydovanton commented Dec 16, 2016

mzeleniuk commented Dec 16, 2016

davydovanton commented Dec 16, 2016

cllns commented Dec 16, 2016

jodosha commented Dec 17, 2016

TiteiKo commented Dec 17, 2016

mzeleniuk commented Dec 19, 2016

TiteiKo Dec 19, 2016

TiteiKo Dec 19, 2016

TiteiKo Dec 19, 2016

TiteiKo Dec 19, 2016

TiteiKo Dec 19, 2016

mzeleniuk commented Dec 19, 2016

cllns commented Dec 19, 2016

mzeleniuk commented Dec 20, 2016

jodosha commented Dec 21, 2016

jodosha commented Dec 21, 2016

TiteiKo commented Dec 21, 2016

AlfonsoUceda left a comment

AlfonsoUceda Jan 29, 2017

AlfonsoUceda Jan 29, 2017

mzeleniuk commented Jan 30, 2017

AlfonsoUceda commented Jan 30, 2017


		# Overview

		Before starting your server, you need to configure database link in <code>.env*</code> files.


		## Prepare tables in database

		After your database variables setup is done you need to create a table in your database before you're be able to launch a development server.

Add instructions to setup PostgreSQL #251

Add instructions to setup PostgreSQL #251

Conversation

mzeleniuk commented Dec 15, 2016

TiteiKo commented Dec 15, 2016

mzeleniuk commented Dec 15, 2016

TiteiKo commented Dec 15, 2016

mzeleniuk commented Dec 15, 2016

davydovanton commented Dec 16, 2016

mzeleniuk commented Dec 16, 2016

davydovanton commented Dec 16, 2016

mzeleniuk commented Dec 16, 2016

davydovanton commented Dec 16, 2016

cllns commented Dec 16, 2016

jodosha commented Dec 17, 2016

TiteiKo commented Dec 17, 2016

mzeleniuk commented Dec 19, 2016

TiteiKo Dec 19, 2016

Choose a reason for hiding this comment

TiteiKo Dec 19, 2016

Choose a reason for hiding this comment

TiteiKo Dec 19, 2016

Choose a reason for hiding this comment

TiteiKo Dec 19, 2016

Choose a reason for hiding this comment

TiteiKo Dec 19, 2016

Choose a reason for hiding this comment

mzeleniuk commented Dec 19, 2016

cllns commented Dec 19, 2016

mzeleniuk commented Dec 20, 2016

jodosha commented Dec 21, 2016

jodosha commented Dec 21, 2016

TiteiKo commented Dec 21, 2016

AlfonsoUceda left a comment

Choose a reason for hiding this comment

AlfonsoUceda Jan 29, 2017

Choose a reason for hiding this comment

AlfonsoUceda Jan 29, 2017

Choose a reason for hiding this comment

mzeleniuk commented Jan 30, 2017

AlfonsoUceda commented Jan 30, 2017