search

rajatkb / Conference-Notify

Conference-Notify is an open source web based application that will aggregate conference information and allow users to search and create recuring reminders and feed for themselves
GNU General Public License v3.0
11 stars 21 forks source link
conference finding-relevant-conferences hacktoberfest nodejs notifier-service pymongo python recurring-notifiers reminders research webscraping wikicfp

readme

Conference-Notify

contributions welcome

Conference-Notify will be an open source web based application that will aggregate conference information from wikicfp , guide2research and other such websites to create a single point of aggregated information and build index over the same. These information can then be searched by users through plain text queries. On finding relevant conferences the user can create recurring notifiers for themselves for the date reminders which can be enabled on both mobile devices and through browser notification.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. You can also refer to this helper document

Prerequisites

MongoDB Installation

Local

This runs MongoDB in your own local machine.

  1. Download MongoDB
  2. Install MongoDB by the following installation instructions.

Atlas

Python 3.6 Installation:

Windows:

  1. Download Python
  2. Install it and ensure that the interpreter will be placed in your execution path.

Linux:

  1. Ubuntu 17.10, Ubuntu 18.04 (and above) come with Python 3.6 by default. You should be able to invoke it with the command python3.

  2. Ubuntu 16.10 and 17.04 do not come with Python 3.6 by default, but it is in the Universe repository. You should be able to install it with the following commands:

sudo apt-get update
sudo apt-get install python3.6

You can then invoke it with the command python3.6.

  1. If you are using Ubuntu 14.04 or 16.04, Python 3.6 is not in the Universe repository, and you need to get it from a Personal Package Archive (PPA). For example, to install Python from the “deadsnakes” PPA, do the following:

sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
sudo apt-get install python3.6

As above, invoke with the command python3.6.

MacOS / MacOS X

  1. Install Homebrew by pasting the below code in terminal /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
  2. Accept the required permissions and finish the installation.
  3. Install python 3.6 from
    brew install python3

Pymongo Client

  1. Install the Pymongo from the command line using
    python -m pip install pymongo
    For various driver installations, Check Installation
  2. For more information, Visit Pymongo client

Node.js

Download node.js and install it.

Angular 6+

Download Angular 6+ from command line
npm install -g @angular/cli

For more information about Angular, Visit Docs

Elastic Search

Elasticsearch is a real-time, distributed storage, search, and analytics engine.

Installation

  1. Verify that your system meets the minimum JVM requirements for Elasticsearch.

  2. Installation process for different systems:

    Windows:

    a. Download the Elasticsearch 7.6.2 Windows zip file from the Elasticsearch download page.
    b. Extract the contents of the zip file to a directory on your computer, for example, C:\Program Files.
    c. Open a command prompt as an Administrator and navigate to the directory that contains the extracted files,
    For example:
    cd C:\Program Files\elasticsearch-7.6.2
    d. Start Elasticsearch:
    bin\elasticsearch.bat

    Debian (Ubuntu):

    curl -L -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.6.2-amd64.deb
    sudo dpkg -i elasticsearch-7.6.2-amd64.deb
    sudo /etc/init.d/elasticsearch start

    rpm (Redhat/Centos/Fedora):

    curl -L -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.6.2-x86_64.rpm
    sudo rpm -i elasticsearch-7.6.2-x86_64.rpm
    sudo service elasticsearch start

    mac (MAC OS X):

    curl -L -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.6.2-darwin-x86_64.tar.gz
    tar -xzvf elasticsearch-7.6.2-darwin-x86_64.tar.gz
    cd elasticsearch-7.6.2
    ./bin/elasticsearch

    brew (MAC OS X):

    brew tap elastic/tap
    brew install elastic/tap/elasticsearch-full
    elasticsearch

    linux :

    curl -L -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.6.2-linux-x86_64.tar.gz
    tar -xzvf elasticsearch-7.6.2-linux-x86_64.tar.gz
    cd elasticsearch-7.6.2
    ./bin/elasticsearch

  3. Make sure Elastic search is up and running:
    a. To test that the Elasticsearch daemon is up and running, try sending an HTTP GET request on port 9200.
    curl http://127.0.0.1:9200
    b. On Windows, if you don’t have cURL installed, point your browser to the URL.
    c. The output appears similar to this:

    {    
"name" : "QtI5dUu",  
"cluster_name" : "elasticsearch",  
"cluster_uuid" : "DMXhqzzjTGqEtDlkaMOzlA",  
"version" : {  
"number" : "7.6.2",  
"build_flavor" : "default",  
"build_type" : "tar",  
"build_hash" : "00d8bc1",  
"build_date" : "2018-06-06T16:48:02.249996Z",  
"build_snapshot" : false,  
"lucene_version" : "7.3.1",  
"minimum_wire_compatibility_version" : "5.6.0",  
"minimum_index_compatibility_version" : "5.0.0"  
},  
"tagline" : "You Know, for Search"  
}

Installing

The project is divided into several components, i.e services

None of this services requires any instllation and can be executed on the fly

Other services coming soon

Deployment

Scrapper-Service
Note: Make sure the configuration file is properly configured for usage, since app.py is reading configuration from the file

>> cd Scrapper-Service

>> python app.py --help
usage: app.py [-h] [-c CONFIG] [-l {debug,warn,error,info}] [-t TEST]
               [-ls {console,file}]

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Specify config.json file ,default: config.json
  -l {debug,warn,error,info}, --log {debug,warn,error,info}
                        Specify the debug level ,default: debug
  -t TEST, --test TEST  Specify whether to test app initialization or run the
                        scrappers ,default: True
  -ls {console,file}, --logStream {console,file}
                        Specify whether to print logs on terminal or to file
                        ,default: console

>> python -m unittest test
It will run all the unit tests written and kept under test folder

Notifier-Service


>> cd Notifier-Service

//For dev

>> npm run-script build

>> npm start 

//For prod

>> npm run-script build

>> npm run-script run

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

👨 Project Admin

👬 Mentors

Name Point of Contact
Maham Arif

Anoop Singh

Sagar Sehgal

Feel free to ask your queries!! 🙌

Contributors

Waiting for some 🧐

License

This project is licensed under the GPL License - see the LICENSE.md file for details

Acknowledgement

A big thanks to GirlScript foundation for having this project under GirlScript Summer of Code