Skip to content
This repository has been archived by the owner on Jun 2, 2021. It is now read-only.

Latest commit

 

History

History
executable file
·
72 lines (59 loc) · 2.34 KB

README.md

File metadata and controls

executable file
·
72 lines (59 loc) · 2.34 KB
Raw

Rails User Auth

Note: This project has now been archieved. Check out the devise gem for a great alternative.

A relatively easy to install and use user authorization for people in a hurry.

Tech stack

  • Database: PostgreSQL
  • Backend: Ruby on Rails
  • Frontend: React, Redux, SASS

Noticeable Features

  • Mobile / tablet friendly responsiveness
  • Email confirmation
  • Password reset
  • SMTP email sending mechanism
  • BEM CSS naming convention
  • 7-1 SASS file structure
  • Minimalistic design

Images

  • PC view:

drawing

  • Mobile view:

drawing

  • Note: These images have a purple border (the actual app doesn't)

Installation

  1. Install Rails if you don't have it
  2. Install PostgreSQL if you don't have it
  3. In terminal:
    1. Go to project directory
    2. bundle install
      1. Installs Rails dependencies
    3. npm install
      1. Installs needed npm packages
    4. rails db:setup
      1. Sets up database

Usage

  1. In terminal:
    1. Go to project directory.
    2. rails g rename:into New-Name
      1. Replace "New-Name" with your app's name.
  2. In code editor:
    1. Replace-all "AppName" with your app's name.
    2. Go to config/application.yml
      1. Place this code snippet at bottom of file:
        1. Replace 'example@gmail.com' with your email
        2. Replace '1234567' with your email's password
      • NB: Make sure that this file (application.yml) is git ignored so you don't accidentally share it on Github or other places
api_key: 'API Key'
domain: 'Domain'
gmail_username: 'example@gmail.com'
gmail_password: '1234567'
  1. In terminal (each in separate tab):
    1. rails s
    2. npm start

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Deployment

If you plan to use a hosting service (e.g. Bluehost, Heroku, etc.) to deploy your site, then don't forget to add gmail_username and gmail_password as configuration variables.

License

MIT