Made by team from POLIMI(Italy) and FER(Croatia University)
CSyllabus is imagined as a web platform which should ease up process of finding and comparing courses on domestic and foreign faculties. It will enable users to discover and compare courses on interactive way through web application. This “one click” app will save time and provide very useful information to interested parties.
Install PostgreSQL 9.6x (https://www.postgresql.org/download/) with pgadmin.
Create new server with hostname localhost. Make sure to write down password and username assigned to newly created user (default username is usually postgres).
After installation create a database in pgadmin that will be used for the csyllabus application and make sure to write down the name you assigned.
If you create a new username and password for the database write it down too. You will use this information later.
Install python 2.7 (https://www.python.org/downloads/).
Check python version in command line with:
python -V
Install pip for python 2.7 (it allready comes shipped with python 2.7.9+) .
Check pip version with
pip -V
Install django with
pip install django
Check django version with:
python -c "import django; print(django.get_version())"
Position yourself in csyllabus root folder.
pip install -r backend/requirements/devl.pip
Download nltk stopwords:
python >>> import nltk >>> nltk.download('stopwords')
In file backend/settings/devl.py field change DATABASES data according to database name, username and password you wrote down in previous steps.
Load the migrations and fixtures into the database:
python manage.py migrate csyllabusapi
python manage.py loaddata backend/apps/csyllabusapi/fixtures/epfl_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/fer_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/laquila_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/mockup_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/polimi_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/stanford_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/texas_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/ucla_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/catech_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/gatech_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/hkust_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/mdh_fixtures_json.json
python manage.py loaddata backend/apps/csyllabusapi/fixtures/illinois_fixtures_json.json
Create a superuser for django application:
python manage.py createsuperuser
To run course similarity algorithm (notice this can take some time) run it with:
python manage.py course_similarity
And finlly run django server:
python manage.py runserver
Install nodeJS (https://nodejs.org/en/download/).
Position youself in the frontend/csyllabus folder.
Run npm install
Serve angular app with ng serve
Backend is made using Django REST Framework, main custom functionalities are located in /backend/csyllabusapi folder which represents a custom djangoo app. It contains custom models, views, managements scripts, helper scripts and database migrations and fixtures. Basic knowledge of Django Framework is required to make changes in the backend.
Recommended IDE is PyCharm, but if you are using other IDE make sure it is connected to statics code analyzer which checks adherence to PEP 8 standard. (https://www.python.org/dev/peps/pep-0008/)
https://google.github.io/styleguide/jsoncstyleguide.xml https://cloud.google.com/apis/design/
Frontend is made using Angular4 Framework with Angular Material Components and Angular CLI, main custom functionalities are located in /frontend/csyllabus and
/frontend/admin folders which represent two different custom angular apps. One is for a public website and the other is for the admin website.
It contains custom modules, custom components, templates and styles. Basic knowledge of Angular Framework is required to make changes in the frontend.
To adhere to code conventiones we must code using tslint to make sure we convey to these style guidelines (https://angular.io/guide/styleguide).
Connect your IDE with tslinf file: frontend/csyllabus/tslint.json
Usually IDE-s do this autoamticaly but if they for some reason didn't or if you are unsure if they did:
Instrunctions for WebStorm: https://www.jetbrains.com/help/webstorm/tslint.html Instrunction fro PyCharm: https://www.jetbrains.com/help/pycharm/tslint.html Intrunctions for VisualStudio Code: https://www.youtube.com/watch?v=-lgBFAtKJ1k
Before pushing to your branch I recommend running ng lint and ng test.
If you coded listening to linter errors and warnings ng lint should say all is fine, if you didnt it will tell you what to correct.
Running ng test will check for unit tests, now these are great and building components and services with angular cli automatically creates some unit tests which give fair code coverage.
- Follow backend/README.md
- Follow frontend/README.md