Giter Site home page Giter Site logo

basic_phoenix_api's Introduction

BasicPhoenixApi

This is a mix template for creating a basic phoenix API with working registration and session endpoints (and very little else). Its only non-default dependencies are Comeonin for password hashing and Guardian for JWT generation and verification.

This template was created by roughly following this guide: http://www.schmitty.me/phoenix-1-3-and-webpack-2-0/.

You will need to install the following mix dependencies globally to use this template:

$ mix archive.install hex mix_templates
$ mix archive.install hex mix_generator

To use this, clone it and navigate to the parent directory of this project. Then:

mix gen ./basic_phoenix_api name_of_project [options]

Options

Several options exist to help set up your project with some extra configuration:

travis_ci

Use this option when you'd like your project to be configured to work with Travis CI. When set, this will generate a .travis.yml file that is configured to use Elixir 1.4.5 and OTP 20.0.

Usage

mix gen ./basic_phoenix_api name_of_project --travis_ci

heroku

Use this option when you'd like your project to be configured to work with Heroku. When set, this will generate several files:

  • Procfile - Configured to run your migrations whenever you make a new release and start your server
  • elixir_buildpack.config - Configured to tell Heroku that you are running on Elixir 1.4.5

Usage

mix gen ./basic_phoenix_api name_of_project --heroku

License

This project uses the MIT License


Created: 2017-07-04Z

basic_phoenix_api's People

Contributors

mbramson 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.