Git Product home page Git Product logo

rails-template's Introduction

Rails API Template

A base template to get started with a Rails 5 API. Includes the following:

  • A rails web server and Postgres database container using docker-compose
  • A .ruby-version file for rvm
  • A .ruby-gemset file to namespace dependencies

Provided dependencies

The following dependencies are installed by default:

  • rails
  • pg
  • rspec
  • rspec-rails
  • shoulda matchers
  • rubocop

Docker containers

A docker-compose.yml file is included which contains:

  • A rails webserver for development, named webserver
  • A postgresql database, named database

To start the containers, run docker-compose up which will build the webserver container and link it to the database.

Both containers are configured using environment files located in the env directory. The database container uses the database.env file, and webserver uses both database.env and web.env.

database.env contains:

  • The user which should own the database (default: postgres)
  • The user's password (default: mysecretpassword)
  • The name of the database (default: rails_db)

web.env contains:

  • The name of the database host to connect to (default: db)
  • The port on which postgresql accepts incoming connections (default: 5432)

rails-template's People

Contributors

andrewspeed avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.