https://github.com/wolfpack-digital/auth-example-api

https://github.com/wolfpack-digital/auth-example-api

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/wolfpack-digital/auth-example-api
• Owner: Wolfpack-Digital
• Created: 2020-01-03T11:25:17.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-19T16:39:37.000Z (almost 2 years ago)
• Last Synced: 2023-03-06T01:17:42.864Z (over 1 year ago)
• Language: Ruby
• Size: 90.8 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# auth_example

This is a Rails 6 app.

## Documentation

This README describes the purpose of this repository and how to set up a development environment. Other sources of documentation are as follows:

* UI and API designs are in `doc/`

## Prerequisites

This project requires:

* Ruby 2.5.3, preferably managed using [rbenv][]

* Chromedriver for Capybara testing

* PostgreSQL must be installed and accepting connections

* [Redis][] must be installed and running on localhost with the default port

On a Mac, you can obtain all of the above packages using [Homebrew][].

If you need help setting up a Ruby development environment, check out this [Rails OS X Setup Guide](https://mattbrictson.com/rails-osx-setup-guide).

## Getting started

### bin/setup

Run the `bin/setup` script. This script will:

* Check you have the required Ruby version

* Install gems using Bundler

* Create local copies of `.env` and `database.yml`

* Create, migrate, and seed the database

### Run it!

1. Run `bin/rake spec` to make sure everything works.

2. Run `bin/rails s` and `bin/sidekiq` to start the app and Sidekiq; alternatively, start both at once with `heroku local`.

[rbenv]:https://github.com/sstephenson/rbenv

[redis]:http://redis.io

[Homebrew]:http://brew.sh