mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2024-11-10 19:57:09 +03:00
make a first rough layout
This commit is contained in:
parent
32f2491c44
commit
adce52418b
|
@ -7,6 +7,8 @@ A Cookiecutter_ template for Django.
|
||||||
|
|
||||||
.. _cookiecutter: https://github.com/audreyr/cookiecutter
|
.. _cookiecutter: https://github.com/audreyr/cookiecutter
|
||||||
|
|
||||||
|
**Todo:** some infos about each section here
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
|
@ -1,14 +1,67 @@
|
||||||
Local Development
|
Local Development
|
||||||
=================
|
=================
|
||||||
|
|
||||||
|
**Todo:** quick intro what this document covers.
|
||||||
|
|
||||||
|
Python Virtualenv
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Step 1: Make a new virtualenv
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Step 2: Install development dependencies
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Step 3: Install Postgres
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo: Section for windows, linux, mac*
|
||||||
|
|
||||||
|
Step 4: Start Django
|
||||||
|
^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
*Todo*
|
*Todo*
|
||||||
|
|
||||||
FAQ
|
FAQ
|
||||||
---
|
^^^
|
||||||
|
|
||||||
*Todo*
|
*Todo*
|
||||||
|
|
||||||
Troubleshooting
|
Troubleshooting
|
||||||
---------------
|
^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Docker
|
||||||
|
------
|
||||||
|
|
||||||
|
Step 1: Install Docker
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Step 2: Install Docker Compose
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Step 3: Start the project
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
FAQ
|
||||||
|
^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Troubleshooting
|
||||||
|
^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
*Todo*
|
*Todo*
|
||||||
|
|
|
@ -1,14 +1,77 @@
|
||||||
Production
|
Production
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
**Todo:** quick intro what this document covers.
|
||||||
|
|
||||||
|
Prerequisites
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Step 1: Register Domain
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Step 2: Create Mailgun Account
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Step 3: Create AWS Account
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
*Todo*
|
*Todo*
|
||||||
|
|
||||||
FAQ
|
FAQ
|
||||||
---
|
^^^
|
||||||
|
|
||||||
*Todo*
|
*Todo*
|
||||||
|
|
||||||
Troubleshooting
|
Troubleshooting
|
||||||
---------------
|
^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Docker
|
||||||
|
------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
FAQ
|
||||||
|
^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Troubleshooting
|
||||||
|
^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Ubuntu
|
||||||
|
------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
FAQ
|
||||||
|
^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Troubleshooting
|
||||||
|
^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Elastic Beanstalk (unsupported)
|
||||||
|
-------------------------------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Heroku (unsupported)
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Python Anywhere (unsupported)
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
*Todo*
|
*Todo*
|
||||||
|
|
|
@ -1,8 +1,39 @@
|
||||||
Setup
|
Setup
|
||||||
=====
|
=====
|
||||||
|
|
||||||
|
**Todo:** quick intro what this document covers.
|
||||||
|
|
||||||
|
Step 1: Install Cookiecutter
|
||||||
|
----------------------------
|
||||||
|
|
||||||
*Todo*
|
*Todo*
|
||||||
|
|
||||||
|
Step 2: Run Cookiecutter Django
|
||||||
|
-------------------------------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Step 3: Install Cookiecutter
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Step 4: Create a new GitHub repo (optional)
|
||||||
|
-------------------------------------------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Step 5: Add the repo to pyup.io (optional)
|
||||||
|
------------------------------------------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Step 6: Add the repo to Travis CI (optional)
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
|
||||||
FAQ
|
FAQ
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,31 @@
|
||||||
The Project
|
The Project
|
||||||
===========
|
===========
|
||||||
|
|
||||||
|
**Todo:** quick intro what this document covers.
|
||||||
|
|
||||||
|
Project Structure
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Features
|
||||||
|
--------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Settings
|
||||||
|
--------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
------------
|
||||||
|
|
||||||
|
*Todo*
|
||||||
|
|
||||||
|
Third Party Services
|
||||||
|
--------------------
|
||||||
|
|
||||||
*Todo*
|
*Todo*
|
||||||
|
|
||||||
FAQ
|
FAQ
|
||||||
|
|
Loading…
Reference in New Issue
Block a user