Skip to content

Latest commit

 

History

History
164 lines (122 loc) · 4.76 KB

README.md

File metadata and controls

164 lines (122 loc) · 4.76 KB
Raw

World Universities

A simple, elegent and powerful web app to display different university related data. Besides, it includes a bunch of useful REST APIs to retrieve university data. Token based APIs are included.Live Demo

Prerequisites

  • python >= 3.8

Install

To run this web app on local machine, the python packages need to be installed are -

Or packages can be install with single command as below - 

pip install Django==3.2.4 djangorestframework requests whitenoise virtualenv

Also needs to install git to setup 'Countries!!!' web app easily. To install git on linux (tested on ubuntu 20.04 LTS), please run this command - 

sudo apt-get install -y git

To install on macOS, windows and other distros of linux, please visit the official page.

For step by step setup procedure, please see the User Guide section below.

User Guide

Here is the user guideline to setup 'Countries!!!' web app on local machine (Linux - tested on ubuntu 20.04 LTS).

Setup Virtual Environment (optional)

At first install virtualenv python package via pip - 

pip install virtualenv

Create a virtual environment - 

virtualenv vCountries

Here vCountries can be any name. Activate virtual environment - 

source vCountries/bin/activate

Setup Countries!!!

At first install git via bash command on terminal - 

sudo apt-get install -y git

Create an empty directory. Let's in our case it is django. Change directory to django - 

mkdir django
cd django

Now clone this repository via git clone command on terminal - 

git clone https://github.com/FahimSifnatul/strativ.git

Run below python commands on terminal to setup NoSQL database SQLite3 - 

python manage.py makemigrations
python manage.py migrate

We are just one step away from successful 'World Universities' web app setup. Run below python command on terminal to play with the web app - 

python manage.py runserver 127.0.0.1:8000

Done. Simple, isn't it? Enjoy rich data about universities of the world.

Token based RESTful APIs

  1. /<api_token>/collect - To collect details data from REST universities API
  2. /<api_token>/list - Returns details info about all universities in JSON format
  3. /<api_token>/search/<university> - Return details info about specific university in JSON format
  4. /<api_token>/search-by-country/<country> - Return details info about universities under specific country in JSON format

[N.B.: replace <api_toke> with a valid user authenticated API token, <university> with a valid university name and <country> with an existing country name]

Contributors

It's an open source project. Everybody is welcomed to contribute.

License

World Universities web app can be copied, modified, distributed for both personal and commercial purposes under MIT License