Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions to setup PostgreSQL #251

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions data/guides.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ categories:
- path: associations
- path: use-your-own-orm
title: Use Your Own ORM
- path: database-configuration
pages:
- path: overview
- path: migrations
pages:
- path: overview
Expand Down
40 changes: 40 additions & 0 deletions source/guides/database-configuration/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Guides - Database Configuration Overview
---

# Overview

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

configure the database link


Open this file for each environment and update <code>DATABASE_URL</code> for your database.

## <a href="http://www.postgresql.org/" target="_blank">PostgreSQL</a>

Setup database variable for the development environment:

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

Setup database variable for the test environment:

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

## Prepare tables in database
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be at the same level of title as Overview

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Setup your 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

In your terminal, enter:

```
% bundle exec hanami db prepare
```

To create a table in database for the test environment, enter:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To setup your test environment database, enter:


```
% HANAMI_ENV=test bundle exec hanami db prepare
```