newsdev/int-newsapps-template

Name: int-newsapps-template

Owner: NYT Newsroom Developers

Description: A template for creating new INT News Apps applications in Django or Flask

Created: 2017-07-14 22:20:40.0

Updated: 2018-05-22 22:47:51.0

Pushed: 2018-02-15 20:59:26.0

Homepage:

Size: 30

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

INT News Apps Template

We don't start new projects that often. But when we do, we have some opinions about how to set up your app.

Currently, INT NewsApps supports:

• Flask + Peewee ORM + PostgreSQL
• Django + PostgreSQL

It's likely that your app has special needs that aren't addressed by our template. But, in the words of Brian Boyer, we're trying to solve 80% of your problems so you can focus on the 20% that makes your app unique.

Step 0: Set up your computer

See our blog post here.

Step 1: Create up your application

Django

.sh -t django -n testproject

Flask

.sh -t flask -n testproject

In either case, we are assuming your project working directory is ~/src/nyt. If that's not true, you can also specify a directory using -d your/directory/here

Step 2: Set up persistence (if you need it)

• We use PostgreSQL 9.6.x for persistence. You can install it locally with homebrew.

   install postgresql
  teuser $USER
  tedb $USER
   -c "alter user $USER with superuser;"
  

Step 3: Work on your app locally

1. in project main dir, add2virtualenv . && add2virtualenv config && add2virtualenv PROJECTNAME
2. make sure export DJANGO_SETTINGS_MODULE=config.dev.settings is in your postactivate (or is otherwise exported)

: TKTKTKTK

Step 4: Deploy to Meta

TKTK LOL