Skip to content

Commit

Permalink
remove unused django-storages and a few more readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Kyle Rockman committed Sep 15, 2017
1 parent fe5adce commit aecd982
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 13 deletions.
1 change: 0 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ RUN pip install coreapi==2.3.0 \
django-permanent==1.1.6 \
django-rest-swagger==2.1.2 \
django-simple-history==1.9.0 \
django-storages==1.5.2 \
django-webpack-loader==0.4.1 \
djangorestframework==3.6.3 \
gevent==1.2.1 \
Expand Down
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Estate is essentially at Terraform UI/UX experience that makes Terraform easier

It is designed around these key principles:

* Self-service infrastructure as code for everyone
* Self-service infrastructure as code
* Reduce the learning curve of Terraform
* Make the right way the easy thing to do
* Standardize usage of Terraform across an organization
Expand All @@ -25,6 +25,11 @@ This project has been presented at [HashiConf 2017 in Austin](https://www.hashic

Terraform files in the bootstrap folder of the repository will provision the necessary AWS resources to run Estate in a production environment.

* Clone this repo with [Git](https://git-scm.com/): `git clone https://github.com/underarmour/estate.git`
* `cd ./bootstrapping/aws/`
* `terraform plan -out=plan`
* `terraform apply "plan"`

**For non-AWS users**

For those who rely on other cloud providers or your own deployment tooling, Estate can be run in docker containers.
Expand Down Expand Up @@ -105,31 +110,31 @@ Sentry is a first class citizen with Estate and the integration requires configu

* `SENTRY_DSN`: [Data Source Name](https://docs.sentry.io/quickstart/#configure-the-dsn) is a variable consisting of configuration for sentry cluster. Example: 'https://key:[email protected]/project'

## Built With
## Major Technologies

* [Docker](url) - description
* [Django](https://www.djangoproject.com/) application with
* [Django Rest Framework](http://www.django-rest-framework.org/) to design it REST API functionality.
* [Gunicorn](http://gunicorn.org/) workers. The backend leverages
* [Webpack](https://webpack.github.io/) using a standard single page app design that leverages
* [Docker](https://www.docker.com/)
* [Django](https://www.djangoproject.com/)
* [Django Rest Framework](http://www.django-rest-framework.org/)
* [Gunicorn](http://gunicorn.org/)
* [Webpack](https://webpack.github.io/)
* [React](https://facebook.github.io/react/)
* [Redux](http://redux.js.org/)

## Developing locally

* Clone this repo with [Git](https://git-scm.com/): `git clone https://github.com/underarmour/estate.git`
* Build the container images from root of the repo: `docker-compose build`
* Run the containers: `docker-compose up`
* Build the container images from root of the repo: `docker-compose build dev`
* Run the containers: `docker-compose up dev`

Every change to `Dockerfile` will require `docker-compose build` to be run. Changes to the codebase will be detected and Estate will be hot-reloaded.
Every change to `Dockerfile` will require `docker-compose build dev` to be run. Changes to the codebase will be detected and Estate will be hot-reloaded.

## Contributing

* Fork the master branch ( https://github.com/underarmour/estate/fork )
* Create your branch (git checkout -b my-branch)
* Commit your changes (git commit -am 'added fixes for something')
* Push to the branch (git push origin my-branch)
* Create a new Pull Request (Travis CI will test your changes)
* Create a new Pull Request
* And you're done!

Features, bug fixes, bug reports and documentation update are all welcome!
Expand Down
1 change: 0 additions & 1 deletion estate/settings/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
from .history import * # NOQA
from .webpack import * # NOQA
from .drf import * # NOQA
from .storages import * # NOQA
from .sentry import * # NOQA
from .estate import * # NOQA
try:
Expand Down

0 comments on commit aecd982

Please sign in to comment.