src/README
author Alexandre Segura <mex.zktk@gmail.com>
Wed, 14 Jun 2017 15:29:01 +0200
changeset 32 52f7a51ef948
parent 31 63be3ce389f7
child 36 36210c4f019f
permissions -rw-r--r--
Fix typos.
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
32
52f7a51ef948 Fix typos.
Alexandre Segura <mex.zktk@gmail.com>
parents: 31
diff changeset
    15
$ pip install -r requirements/dev.txt
24
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
$ python manage.py migrate
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
$ python manage.py collectstatic
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
$ python manage.py createsuperuser
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
$ python manage.py runserver
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
```
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
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
    24
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
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
    26
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
## Usage
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
TODO: Write usage instructions
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
## History
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
TODO: Write 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
## Credits
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
TODO: Write 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
## License
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
TODO: Write license