|
1 |
| -==================== |
2 |
| -Platforma Redakcyjna |
3 |
| -==================== |
| 1 | +# Platforma Redakcyjna |
| 2 | + |
| 3 | + |
| 4 | +## Opis projektu |
4 | 5 |
|
5 |
| -Opis projektu |
6 |
| -============= |
7 | 6 | Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl.
|
8 | 7 |
|
9 |
| -Instalacja i użycie |
10 |
| -=================== |
11 |
| -#. Upewnij się, że masz Pythona w wersji co najmniej 3.5. |
12 |
| -#. Stwórz i uruchom wirtualne środowisko: |
13 | 8 |
|
14 |
| - python3 -m venv ve |
15 |
| - . ve/bin/activate |
| 9 | +## Instalacja i użycie |
| 10 | + |
| 11 | +1. Upewnij się, że masz Pythona w wersji co najmniej 3.5. |
| 12 | +2. Stwórz i uruchom wirtualne środowisko: |
| 13 | + |
| 14 | +```bash |
| 15 | +python3 -m venv ve |
| 16 | +. ve/bin/activate |
| 17 | +``` |
16 | 18 |
|
17 |
| -#. Przejdź do katalogu serwisu w konsoli |
18 |
| -#. Zainstaluj wymagane biblioteki komendą:: |
| 19 | +3. Przejdź do katalogu serwisu w konsoli |
| 20 | +4. Zainstaluj wymagane biblioteki komendą:: |
19 | 21 |
|
20 |
| - pip install -r requirements/requirements.txt |
| 22 | +```bash |
| 23 | +pip install -r requirements/requirements.txt |
| 24 | +``` |
21 | 25 |
|
22 |
| -#. Skopiuj zawartość pliku `src/redakcja/localsettings.sample` do `src/redakcja/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. |
| 26 | +5. Skopiuj zawartość pliku `src/redakcja/localsettings.sample` do `src/redakcja/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. |
23 | 27 |
|
24 |
| -#. Wypełnij bazę danych:: |
| 28 | +6. Wypełnij bazę danych:: |
25 | 29 |
|
26 |
| - src/manage.py migrate |
| 30 | +```bash |
| 31 | +src/manage.py migrate |
| 32 | +``` |
27 | 33 |
|
28 |
| -#. Uruchom serwer deweloperski:: |
| 34 | +7. Uruchom serwer deweloperski:: |
29 | 35 |
|
30 |
| - src/manage.py runserver |
| 36 | +```bash |
| 37 | +src/manage.py runserver |
| 38 | +``` |
31 | 39 |
|
32 |
| -#. Strategie wdrożeniowe opisane są w `Dokumentacji Django <http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>`_. |
| 40 | +8. Strategie wdrożeniowe opisane są w [Dokumentacji Django](http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>). |
33 | 41 | Do przygotowania wersji do wdrożenia możesz użyć komendy `make deploy`.
|
34 | 42 |
|
35 | 43 |
|
36 |
| -Testy |
37 |
| -==== |
| 44 | +## Testy |
38 | 45 |
|
39 |
| - $ pip install -r requirements-test.txt |
40 |
| - $ make test |
| 46 | +```bash |
| 47 | +pip install -r requirements-test.txt |
| 48 | +make test |
| 49 | +``` |
41 | 50 |
|
42 | 51 | JavaScript (wymagany node.js i xsltproc):
|
43 | 52 |
|
44 |
| - $ npm install |
45 |
| - $ ./node_modules/.bin/mocha -u tdd $(find src -name *_test.js) |
| 53 | +```bash |
| 54 | +npm install |
| 55 | +./node_modules/.bin/mocha -u tdd $(find src -name *_test.js) |
| 56 | +``` |
0 commit comments