src/README
author ymh <ymh.work@gmail.com>
Wed, 28 Nov 2018 15:45:37 +0100
changeset 180 62bffc051e1c
parent 37 5ce9218fb3e0
permissions -rw-r--r--
Add first version of deploy scripts
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
36
36210c4f019f reorganize urls and add user management api urls
ymh <ymh.work@gmail.com>
parents: 32
diff changeset
    14
$ mkvirtualenv -p `which python3` irinotes
36210c4f019f reorganize urls and add user management api urls
ymh <ymh.work@gmail.com>
parents: 32
diff changeset
    15
$ cd requirements
36210c4f019f reorganize urls and add user management api urls
ymh <ymh.work@gmail.com>
parents: 32
diff changeset
    16
$ pip install -r dev.txt
36210c4f019f reorganize urls and add user management api urls
ymh <ymh.work@gmail.com>
parents: 32
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
37
5ce9218fb3e0 small doc additions to the readme
ymh <ymh.work@gmail.com>
parents: 36
diff changeset
    31
The following library have been used:
5ce9218fb3e0 small doc additions to the readme
ymh <ymh.work@gmail.com>
parents: 36
diff changeset
    32
http://django-rest-auth.readthedocs.io/en/latest/index.html
5ce9218fb3e0 small doc additions to the readme
ymh <ymh.work@gmail.com>
parents: 36
diff changeset
    33
https://django-allauth.readthedocs.io/en/latest/
5ce9218fb3e0 small doc additions to the readme
ymh <ymh.work@gmail.com>
parents: 36
diff changeset
    34
http://getblimp.github.io/django-rest-framework-jwt/
5ce9218fb3e0 small doc additions to the readme
ymh <ymh.work@gmail.com>
parents: 36
diff changeset
    35
5ce9218fb3e0 small doc additions to the readme
ymh <ymh.work@gmail.com>
parents: 36
diff changeset
    36
Lancement serveur smtp python:
5ce9218fb3e0 small doc additions to the readme
ymh <ymh.work@gmail.com>
parents: 36
diff changeset
    37
sudo python3 -m smtpd -c DebuggingServer -n localhost:25
24
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
## History
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 history
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
## Credits
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
TODO: Write credits
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
## License
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
3b3999550508 first data model for backend
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
TODO: Write license