https://github.com/macabdul9/aws-django
GitHub repository for AWS CodeStar Python (Django) web application mysite-1.
https://github.com/macabdul9/aws-django
Last synced: 6 months ago
JSON representation
GitHub repository for AWS CodeStar Python (Django) web application mysite-1.
- Host: GitHub
- URL: https://github.com/macabdul9/aws-django
- Owner: macabdul9
- Created: 2019-05-21T15:44:24.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-21T15:45:08.000Z (about 7 years ago)
- Last Synced: 2025-07-14T07:54:40.581Z (about 1 year ago)
- Language: HTML
- Size: 11.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Welcome to the AWS CodeStar sample web application
==================================================
This sample code helps get you started with a simple Django web application
deployed by AWS Elastic Beanstalk and AWS CloudFormation.
What's Here
-----------
This sample includes:
* README.md - this file
* ebdjango/ - this directory contains your Django project files. Note that this
directory contains a Django config file (settings.py) that includes a pre-defined
SECRET_KEY. Before running in a production environment, you should replace this
application key with one you generate
(see https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/#secret-key for details)
* helloworld/ - this directory contains your Django application files
* manage.py - this Python script is used to start your Django web application
* .ebextensions/ - this directory contains the Django configuration file that
allows AWS Elastic Beanstalk to deploy your Django application
* buildspec.yml - this file is used by AWS CodeBuild to build and test
your application
* requirements.txt - this file is used to install Python dependencies needed by
the Django application
* template.yml - this file contains the description of AWS resources used by AWS
CloudFormation to deploy your infrastructure
* template-configuration.json - this file contains the project ARN with placeholders used for tagging resources with the project ID
Getting Started
---------------
These directions assume you want to develop on your local computer, and not
from the Amazon EC2 instance itself. If you're on the Amazon EC2 instance, the
virtual environment is already set up for you, and you can start working on the
code.
To work on the sample code, you'll need to clone your project's repository to your
local computer. If you haven't, do that first. You can find instructions in the
AWS CodeStar user guide.
1. Create a Python virtual environment for your Django project. This virtual
environment allows you to isolate this project and install any packages you
need without affecting the system Python installation. At the terminal, type
the following command:
$ virtualenv .venv
2. Activate the virtual environment:
$ activate ./venv/bin/activate
3. Install Python dependencies for this project:
$ pip install -r requirements.txt
4. (Optional) Enable Django's debug mode for development:
$ export DJANGO_DEBUG=True
5. Start the Django development server:
$ python manage.py runserver
6. Open http://127.0.0.1:8000/ in a web browser to view your application.
What Do I Do Next?
------------------
Once you have a virtual environment running, you can start making changes to
the sample Django web application. We suggest making a small change to
/helloworld/templates/index.html first, so you can see how changes pushed to
your project's repository are automatically picked up and deployed to the Amazon EC2
instance by AWS Elastic Beanstalk. (You can watch the progress on your project dashboard.)
Once you've seen how that works, start developing your own code, and have fun!
To run your tests locally, go to the root directory of the sample code and run
the `python manage.py test` command, which AWS CodeBuild also runs through
your `buildspec.yml` file.
To test your new code during the release process, modify the existing tests or
add tests to the tests directory. AWS CodeBuild will run the tests during the
build stage of your project pipeline. You can find the test results
in the AWS CodeBuild console.
Learn more about AWS CodeBuild and how it builds and tests your application here:
https://docs.aws.amazon.com/codebuild/latest/userguide/concepts.html
Learn more about AWS CodeStar by reading the user guide. Ask questions or make
suggestions on our forum.
User Guide: http://docs.aws.amazon.com/codestar/latest/userguide/welcome.html
Forum: https://forums.aws.amazon.com/forum.jspa?forumID=248
How Do I Add Template Resources to My Project?
------------------
To add AWS resources to your project, you'll need to edit the `template.yml`
file in your project's repository. You may also need to modify permissions for
your project's worker roles. After you push the template change, AWS CodeStar
and AWS CloudFormation provision the resources for you.
See the AWS CodeStar user guide for instructions to modify your template:
https://docs.aws.amazon.com/codestar/latest/userguide/how-to-change-project#customize-project-template.html
What Should I Do Before Running My Project in Production?
------------------
AWS recommends you review the security best practices recommended by the framework
author of your selected sample application before running it in production. You
should also regularly review and apply any available patches or associated security
advisories for dependencies used within your application.
Best Practices: https://docs.aws.amazon.com/codestar/latest/userguide/best-practices.html?icmpid=docs_acs_rm_sec