Skip to content

Latest commit

 

History

History
101 lines (79 loc) · 4.58 KB

README.md

File metadata and controls

101 lines (79 loc) · 4.58 KB

Phoenix Starter

CI

This repo contains the base app we use to get our Elixir / Phoenix apps started at NewAperio.

The goal of this repo is to enable our development teams to start fast with a solid foundation. This app is updated with new releases and includes the boilerplate configuration we typically use when bootstrapping new products.

Technologies

The following technologies are included and configured with our defaults:

Usage

The repo is setup as a GitHub template to make it easy to get started.

  1. Click the "Use this template" button. This will setup a new repo with a clean history.
  2. Clone the new repo locally.
  3. Run the init script to rename the starter project and do some other housekeeping: $ ./bin/init.sh MyApp my_app.
  4. Commit the result: $ git add --all . && git commit -m "Initalize starter project".

Updating

To update a Phoenix app generated from this repo, you need to compare the changes between the version that initialized your repo and the current version.

You can find your current version in the .starter-version file. This is the git tag that generated your app.

You can find changes in the CHANGELOG.

You can also check the diff on GitHub between your version and the latest version. There's a helpful script that will grab the version information and print out the URLs.

./bin/starter-version-info.sh

After updating make sure to update the version in .starter-version with the tag you updated to.

License

Phoenix Starter is Copyright © 2020 NewAperio. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About NewAperio

PhoenixStarter is built by NewAperio, LLC.

NewAperio is a web and mobile design and development studio. We offer expert Elixir and Phoenix development as part of our portfolio of services. Get in touch to see how our team can help you.