Skip to content
This repository was archived by the owner on Dec 6, 2019. It is now read-only.

Improved the readme #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
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
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,31 @@
# README
# 🚧🚧🚧 Work in progress 🚧🚧🚧
This is not a complete project nor should it be taken seriously, yet. Please do not create any issues not pull requests.

### Steps to set up project
* Ruby version 2.5.1p57

* clone repo
```
git clone https://github.com/quickwords/quickwords-api.git
cd quickwords-api
```
* Clone the repo
```bash
git clone https://github.com/quickwords/quickwords-api.git
cd quickwords-api
```

* Install dependecies
```bash
bundle
```

* install dependecies
```
bundle
```
* import **master.key** and **.env.local** to the root directory of the project
* Import **master.key** and **.env.local** to the root directory of the project

* create database user
```
psql
CREATE USER quickwords WITH CREATEDB PASSWORD '<<our_password>>';

```

* Create a database user
```bash
psql
CREATE USER quickwords WITH CREATEDB PASSWORD '<<our_password>>';
```

* Database initialization
```
rails db:setup
```
```
rails db:setup
```

***For missing credentails and files ask @gtluszcz**
**For missing credentails and files ask @gtluszcz**