src/README
author ymh <ymh.work@gmail.com>
Wed, 14 Jun 2017 15:17:51 +0200
changeset 31 63be3ce389f7
parent 24 3b3999550508
child 32 52f7a51ef948
permissions -rw-r--r--
improve api
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
# IRINOTES backoffice
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
Back office for the IRINOTES application
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
## Installation
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
Please follow the command below to bootstrap the project
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
```shell
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
$ mkdir -p run/{db,log,web}
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
$ mkdir -p run/web/{media,static}
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
$ cp .env.tmpl .env
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
$ vi .env
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
$ mkvirtualenv irinotes
31
63be3ce389f7 improve api
ymh <ymh.work@gmail.com>
parents: 24
diff changeset
    15
$ cd requirements
63be3ce389f7 improve api
ymh <ymh.work@gmail.com>
parents: 24
diff changeset
    16
$ pip install dev.txt
63be3ce389f7 improve api
ymh <ymh.work@gmail.com>
parents: 24
diff changeset
    17
$ cd ..
24
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
$ python manage.py migrate
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
$ python manage.py collectstatic
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
$ python manage.py createsuperuser
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
$ python manage.py runserver
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
```
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
You can now visit the following url in your browser <http://127.0.0.1:8000> .
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
Admin interface is at <http://127.0.0.1:8000/admin>
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
## Usage
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
TODO: Write usage instructions
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
## History
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
TODO: Write history
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
## Credits
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
TODO: Write credits
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
## License
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
TODO: Write license