Skip to content
Snippets Groups Projects
Commit 6ebfea49 authored by Piotr Gawron's avatar Piotr Gawron
Browse files

specify type of code

parent 6b1b2429
No related branches found
No related tags found
1 merge request!297Update readme
Pipeline #35775 passed
...@@ -20,7 +20,7 @@ python manage.py superworker ...@@ -20,7 +20,7 @@ python manage.py superworker
sudo apt-get install python3, virtualenv, libcurl4-gnutls-dev, libpng-dev, libfreetype6-dev, libpq-dev, gcc, g++, python3-dev, libgnutls28-dev, libjpeg-dev, libfreetype6-dev, git sudo apt-get install python3, virtualenv, libcurl4-gnutls-dev, libpng-dev, libfreetype6-dev, libpq-dev, gcc, g++, python3-dev, libgnutls28-dev, libjpeg-dev, libfreetype6-dev, git
``` ```
- install nodejs - install nodejs
``` ```bash
curl -sL https://deb.nodesource.com/setup_14.x | bash - curl -sL https://deb.nodesource.com/setup_14.x | bash -
apt-get install nodejs apt-get install nodejs
``` ```
...@@ -28,17 +28,22 @@ apt-get install nodejs ...@@ -28,17 +28,22 @@ apt-get install nodejs
## Developer project installation ## Developer project installation
- clone smasch: - clone smasch:
```
```bash
git clone ssh://git@git-r3lab-server.uni.lu:8022/NCER-PD/scheduling-system.git git clone ssh://git@git-r3lab-server.uni.lu:8022/NCER-PD/scheduling-system.git
``` ```
- setup virtualenv with clean python3 working environment and start using it. Important python3.6 or higher is required - setup virtualenv with clean python3 working environment and start using it. Important python3.6 or higher is required
```
```bash
cd scheduling-system cd scheduling-system
virtualenv env -p python3 virtualenv env -p python3
. env/bin/activate . env/bin/activate
``` ```
- install smasch dependencies - install smasch dependencies
```
```bash
pip install -r requirements.txt pip install -r requirements.txt
pip install -r requirements-dev.txt pip install -r requirements-dev.txt
npm install npm install
...@@ -63,7 +68,7 @@ DATABASES = { ...@@ -63,7 +68,7 @@ DATABASES = {
- postgresql database configuration looks like: - postgresql database configuration looks like:
```python3 ```python
DATABASES = { DATABASES = {
'default': { 'default': {
'ENGINE': 'django.db.backends.postgresql_psycopg2', 'ENGINE': 'django.db.backends.postgresql_psycopg2',
...@@ -88,12 +93,14 @@ After database connection is configured setup a database by applying migration s ...@@ -88,12 +93,14 @@ After database connection is configured setup a database by applying migration s
## Development ## Development
Remember, that before working you have to activate _virtualenv_, by: Remember, that before working you have to activate _virtualenv_, by:
```
```bash
devel@host ~/home/smash/scheduling-system $ . env/bin/activate devel@host ~/home/smash/scheduling-system $ . env/bin/activate
``` ```
In order to run development server, run: In order to run development server, run:
```
```bash
devel@host ~/home/smash/scheduling-system/smash $ ./manage.py runserver devel@host ~/home/smash/scheduling-system/smash $ ./manage.py runserver
``` ```
and go to `127.0.0.1:8000` in browser and go to `127.0.0.1:8000` in browser
...@@ -110,7 +117,8 @@ pip install psycopg2 --global-option=build_ext --global-option="-I/usr/local/Cel ...@@ -110,7 +117,8 @@ pip install psycopg2 --global-option=build_ext --global-option="-I/usr/local/Cel
## Production deployment ## Production deployment
Smasch can be deployed using debian package provided in lcsb repository: Smasch can be deployed using debian package provided in lcsb repository:
```
```bash
echo "deb http://repo-r3lab.uni.lu/debian/ stable main" | tee /etc/apt/sources.list.d/repo-r3lab.list echo "deb http://repo-r3lab.uni.lu/debian/ stable main" | tee /etc/apt/sources.list.d/repo-r3lab.list
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 0xcb185f4e31872412 sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 0xcb185f4e31872412
apt-get update apt-get update
...@@ -118,7 +126,8 @@ apt-get install -y smasch ...@@ -118,7 +126,8 @@ apt-get install -y smasch
``` ```
After smasch is installed you can start/stop it using systemd: After smasch is installed you can start/stop it using systemd:
```
```bash
service smasch start service smasch start
service smasch stop service smasch stop
``` ```
...@@ -130,7 +139,7 @@ Configuration of smasch (`local_settings.py`) is in `/etc/smasch/smasch.py`. ...@@ -130,7 +139,7 @@ Configuration of smasch (`local_settings.py`) is in `/etc/smasch/smasch.py`.
### Disable two steps authentication for a specific user ### Disable two steps authentication for a specific user
``` ```bash
./manage.py two_factor_disable ${USERNAME} ./manage.py two_factor_disable ${USERNAME}
``` ```
...@@ -138,7 +147,7 @@ Configuration of smasch (`local_settings.py`) is in `/etc/smasch/smasch.py`. ...@@ -138,7 +147,7 @@ Configuration of smasch (`local_settings.py`) is in `/etc/smasch/smasch.py`.
to import public holidays run: to import public holidays run:
``` ```bash
./manage.py holidays ${YEARS} ./manage.py holidays ${YEARS}
``` ```
...@@ -146,6 +155,6 @@ where ${YEARS} should be a space separated list of years for which the holidays ...@@ -146,6 +155,6 @@ where ${YEARS} should be a space separated list of years for which the holidays
example: example:
``` ```bash
./manage.py holidays 2017 2018 2019 ./manage.py holidays 2017 2018 2019
``` ```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment