Merge pull request RyanNoelk#174 from RyanNoelk/dev

Dev

.gitignore

@@ -18,6 +18,7 @@ frontend/.DS_Store
 static-files/
 database/
 frontend/build/
+frontend/jest/
 
 servies/static-files/
 servies/side-media/

.travis.yml

@@ -16,3 +16,4 @@ before_install:
 
 script:
 - docker-compose -f docker-compose-test.yml -p test run --rm --entrypoint 'bash tests.sh' api
+- docker-compose -f docker-compose-test.yml -p test run --rm --entrypoint 'npm test' node

CONTRIBUTING.md

@@ -0,0 +1,137 @@
+# Contributing to this project
+
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of
+the developers managing and developing this open source project. In return,
+they should reciprocate that respect in addressing your issue or assessing
+patches and features.
+
+
+## Using the issue tracker
+
+The issue tracker is the preferred channel for [bug reports](#bugs),
+[features requests](#features) and [submitting pull
+requests](#pull-requests), but please respect the following restrictions:
+
+* Please **do not** use the issue tracker for personal support requests (use
+  [Stack Overflow](http://stackoverflow.com)).
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and
+  respect the opinions of others.
+
+
+<a name="bugs"></a>
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** &mdash; check if the issue has already been
+   reported.
+
+2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
+   latest `master` or development branch in the repository.
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report. What is
+your environment? What steps will reproduce the issue? What browser(s) and OS
+experience the problem? What would you expect to be the outcome? All these
+details will help people to fix any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the browser/OS environment in which it occurs. If
+> suitable, include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their
+> merits).
+
+
+<a name="features"></a>
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to *you* to make a strong
+case to convince the project's developers of the merits of this feature. Please
+provide as much detail and context as possible.
+
+
+<a name="pull-requests"></a>
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic
+help. They should remain focused in scope and avoid containing unrelated
+commits.
+
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code, porting to a different language),
+otherwise you risk spending a lot of time working on something that the
+project's developers might not want to merge into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).
+
+Follow this process if you'd like your work considered for inclusion in the
+project:
+
+1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/<repo-name>
+   # Navigate to the newly cloned directory
+   cd <repo-name>
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/RyanNoelk/OpenEats
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout <dev-branch>
+   git pull upstream <dev-branch>
+   ```
+
+3. Create a new topic branch (off the `dev` branch) to
+   contain your feature, change, or fix:
+
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Use Git's
+   [interactive rebase](https://help.github.com/articles/interactive-rebase)
+   feature to tidy up your commits before making them public.
+
+5. Locally merge (or rebase) the upstream development branch into your topic branch:
+
+   ```bash
+   git pull [--rebase] upstream dev
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```bash
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description against the `dev` branch`.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
+license your work under the same license as that used by the project.
+
+Shout-out to [necolas](https://github.com/necolas/issue-guidelines) for the contributing template.

README.md

@@ -2,97 +2,15 @@
 
 [![Build Status](https://travis-ci.org/RyanNoelk/OpenEats.svg?branch=master)](https://travis-ci.org/RyanNoelk/OpenEats)
 
-OpenEats is a recipe management site that allows users to create, share, and store recipes. This fork uses Django Rest Framework as a backend and React (with flux) as a front end. 
+OpenEats is a recipe management site that allows users to create, share, and store their personal collection of recipes. This fork uses Django Rest Framework as a backend and React (with flux) as a front end.
 
-The main goals of this project are twofold. One, I wanted a place to store my personal collection of recipes and share them with close friends and family. Two, I wanted to learn React :). I went digging around for a starting point and gathering ideas when I came across open eats. It had some cool ideas and was well documented for the most part. 
-
-I have a lot of ideas as far as features go. But since I moved the whole UI to React and the backend to a pure API, I'm currently working on getting the core of the project stable.  The Core, in my mind, consists of a few things.
+The usage for the app is intended for a single user or a small group. For my personal use, I would be an admin user and a few (about 5-6) friends and family would be normal users. Admin users can add other users to the project (no open sign-ups), make changes to the available Cuisines and Courses, and add to the homepage banner. Normal users just have the ability to add recipes. Below are a few of the core features the app provides.
 
 - Creating, viewing, and editing recipes.
 - Browsing and searching for recipes.
-- A simple homepage and about page.
-
-# Running the App
-
-The recommended way to run this app is with docker. you can install docker [here](https://www.docker.com/products/overview). If you are not familiar with docker you can read more about it on there [website](https://www.docker.com/what-docker).
-
-If you are looking to run the app without docker, see the instructions [here](docs/Running_without_Docker.md)
-
-### Running the app with docker for production
-
-If you are looking to run this in production, there is no need to clone the repo. 
-
-First, create two files:
-- docker-prod.yml - This file can be found in the in the repo.
-- env_prod.list - The settings file `env_stg.list` can be used as an example.
-
-The `docker-prod.yml` contains the list of images and commands to run the app. It come with an nginx reverse proxy that by default will run on port 80. You will most likely want to change the port that nginx runs on as well as use a fix tag for the image. By default all are set to latest.
-
-Most of the settings in your `env_prod.list` can stay the same as `env_stg.list` that is in this repo. It is highly recommended to change the django secret key when running this app. Once the files have been created run:
-
-```bash
-docker-compose -f docker-prod.yml up -d
-```
-
-### Running the app with docker for development
-```bash
-git clone https://github.com/RyanNoelk/OpenEats.git
-cd openeats
-git checkout dev
-docker-compose build
-docker-compose up -d
-```
-
-### First Time Setup
-
-Regardless of if your running the app in production or development, you need to seed the database.
+- Creating grocery lists
 
-Run `docker-compose run --rm api bash` to open a bash shell to the API. 
-```bash
-./manage.py migrate
-./manage.py collectstatic
-./manage.py createsuperuser
-./manage.py loaddata course_data.json
-./manage.py loaddata cuisine_data.json
-```
-
-If you want to add some test data we can load a few recipes and some news data. This data isn't really needed unless you just wanna see how the app looks and if its working.
-* `./manage.py loaddata news_data.json`
-* `./manage.py loaddata recipe_data.json`
-* `./manage.py loaddata ing_data.json`
-* `./manage.py loaddata direction_data.json`
-
-# Running tests
-
-## API
-
-API tests run in their own container with the following command (`-p tests` is to use a different prefix
-from the normal containers to avoid overlap):
-
-```bash
-docker-compose -f docker-compose-test.yml -p test up -d
-```
-
-And then either see the result of the tests
-
-```bash
-docker-compose -f docker-compose-test.yml -p test logs api
-````
-
-Or to just get the response code (`0` for success/no errors):
-
-```bash
-docker wait tests_api_1
-```
-
-To avoid the docker startup overhead or for more fine-grained control of which tests to run:
-
-```bash
-docker-compose -f docker-compose-test.yml -p test run --rm api bash
-./tests.sh # Optional DB reset
-./manage.py test -k
-```
+### [Read the docs on getting started here!](https://github.com/RyanNoelk/OpenEats/docs/Running_the_App.md)
 
 # Contributing
-
-All contributions are welcome! If you are are having an problem or find a bug please create an issue in github. If you would like to contribute, feel free to grab any unassigned issue with github issues.
+Please read the [contribution guidelines](https://github.com/RyanNoelk/OpenEats/CONTRIBUTING.md) in order to make the contribution process easy and effective for everyone involved.

api/base/requirements.txt

@@ -15,6 +15,7 @@ Pillow==2.7.0
 django-cors-headers==1.3.1
 MySQL-python==1.2.5
 mock==2.0.0
+pytz==2016.10
 
 # Will need these once I start supporting metric mesurments
 sympy==0.7.6.1

api/base/settings.py

@@ -134,9 +134,8 @@
 
 WSGI_APPLICATION = 'base.wsgi.application'
 
-# Local time zone for this installation. Choices can be found here:
-# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
-TIME_ZONE = os.environ.get('DJANGO_TIME_ZONE', 'America/Chicago')
+# Automatically find the correct time zone to use.
+USE_TZ = True
 
 # Language code for this installation. All choices can be found here:
 # http://www.i18nguy.com/unicode/language-identifiers.html

docker-compose-test.yml

@@ -11,6 +11,17 @@ services:
       - db
     env_file:
       env_test.list
+  node:
+    build: frontend/
+    command: npm start
+    volumes:
+      - node_modules:/code/node_modules
+    depends_on:
+      - api
+    ports:
+      - "8080:8080"
+    env_file:
+      env_test.list
   db:
     image: mariadb
     volumes:

docker-compose.yml

@@ -2,7 +2,7 @@ version: '2'
 services:
   api:
     build: api/
-    restart: always
+    restart: on-failure
     volumes:
       - static-files:/code/static-files
       - site-media:/code/site-media

docker-prod.yml

@@ -3,7 +3,7 @@ services:
   api:
     image: openeats/api
     command: ./base/gunicorn_start.sh
-    restart: always
+    restart: on-failure
     volumes:
       - static-files:/code/static-files
       - site-media:/code/site-media

docker-stage.yml

@@ -3,7 +3,7 @@ services:
   api:
     build: api/
     command: ./base/gunicorn_start.sh
-    restart: always
+    restart: on-failure
     volumes:
       - static-files:/code/static-files
       - site-media:/code/site-media

docs/Running_the_App.md

@@ -0,0 +1,49 @@
+# Running the App
+
+The recommended way to run this app is with docker. You can install docker [here](https://www.docker.com/products/overview). If you are not familiar with docker you can read more about it on [there website](https://www.docker.com/what-docker).
+
+If you are looking to run the app without docker, see the instructions [here](docs/Running_without_Docker.md)
+
+### Running the app with docker for production
+
+If you are looking to run this in production, there is no need to clone the repo.
+
+First, create two files:
+- docker-prod.yml - This file can be found in the in the repo.
+- env_prod.list - The settings file `env_stg.list` can be used as an example.
+
+The `docker-prod.yml` contains the list of images and commands to run the app. It come with an nginx reverse proxy that by default will run on port 80. You will most likely want to change the port that nginx runs on as well as use a fix tag for the image. By default all are set to latest.
+
+Most of the settings in your `env_prod.list` can stay the same as `env_stg.list` that is in this repo. It is highly recommended to change the django secret key when running this app. Once the files have been created run:
+
+```bash
+docker-compose -f docker-prod.yml up -d
+```
+
+### Running the app with docker for development
+```bash
+git clone https://github.com/RyanNoelk/OpenEats.git
+cd openeats
+git checkout dev
+docker-compose build
+docker-compose up -d
+```
+
+### First Time Setup
+
+Regardless of if your running the app in production or development, you need to seed the database.
+
+Run `docker-compose run --rm api bash` to open a bash shell to the API.
+```bash
+./manage.py migrate
+./manage.py collectstatic
+./manage.py createsuperuser
+./manage.py loaddata course_data.json
+./manage.py loaddata cuisine_data.json
+```
+
+If you want to add some test data we can load a few recipes and some news data. This data isn't really needed unless you just wanna see how the app looks and if its working.
+* `./manage.py loaddata news_data.json`
+* `./manage.py loaddata recipe_data.json`
+* `./manage.py loaddata ing_data.json`
+* `./manage.py loaddata direction_data.json`