From af21e6b4d0cc379dd3f5fd4cdbeef7a79975b477 Mon Sep 17 00:00:00 2001 From: DCzajkowski Date: Mon, 1 Oct 2018 21:15:32 +0200 Subject: [PATCH] Improved the readme --- README.md | 43 +++++++++++++++++++++---------------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index d9a5a97..f6bfb23 100644 --- a/README.md +++ b/README.md @@ -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 '<>'; - - ``` - +* Create a database user +```bash +psql +CREATE USER quickwords WITH CREATEDB PASSWORD '<>'; +``` * Database initialization - ``` - rails db:setup - ``` +``` +rails db:setup +``` - ***For missing credentails and files ask @gtluszcz** \ No newline at end of file +**For missing credentails and files ask @gtluszcz**