Mr.Draper
Simple blog application with oAuth enabled for user registration and login and integrate 2 factor authentication for posts. Integrate 2FA using Twillio Authy app & SMS.
Tools
Docker
Pre-requisites:
- Docker (Latest Version)
- Docker Compose (Latest Version)
Steps:
Docker on Linux/Mac:
Setup Application:
- Run
docker-compose up --build
- Run
docker-compose run app yarn install --check-files
to load node_nodules in docker container - Open a new Tab and run
docker-compose run app rails db:create db:migrate
- Run
rails sample_data:load_db_to_docker
- Paste the
master.key
in config directory. You have to Obtain it from the Code Owner - Visit
localhost:3000
to your browser - There you go 🎉
Setup Manually
Pre-requisites:
- Ruby 2.5.3
- Rails 5.2.3
- Postgres (Latest Version)
Steps:
Ruby on Rails Installation on Linux/Mac:
- Visit Go Rails
- Under Guides->Installation, follow all the steps to install Ruby on Rails
App uses sidekiq
as background worker, which requires
Redis Installation:
- Linux
sudo apt-get install redis-server
- Mac
brew install redis
Setup Application:
Once Rails/Ruby installed, app can be configured by following below steps:
- Clone the repo
git@github.com:aliahmed922/mr.draper.git
- Run
bundle
andyarn install --check-files
- Run
cp config/webpacker.manual.yml config/webpacker.yml
- Run
cp config/database.manual.yml config/database.yml
- Update
.env.development
with your Postgresusername/password
- Run
rails db:create db:migrate
- Run
rails sample_data:load_db
to get the Sample Data - Paste the
master.key
in config directory. You have to Obtain it from the Code Owner - Run
cp Procfile.example.dev Procfile.dev
- Run
foreman start --procfile Procfile.dev
- There you go 🎉