search

superrcoop / weconnec

The project intends to resolve the need for a central platform that allows, primarily students to share resources among themselves
https://weconnec.xyz
GNU General Public License v3.0
0 stars 0 forks source link
artificial-intelligence big-data data-analytics data-science deeplearning flask image-processing javascript machine-learning natural-language-processing python python-spacy vuejs weconnec

readme

weconnec

Description

A web-based platform that grants users access to a library of documents as well as allow them to share documents with persons from their friend list after signing up for an account. Users have the option of making uploaded resources public or private. The platform's main function is to allow users to search through a large pool of documents return relevant information based on the query in a timely manner.

Getting Started !

This Web app requires the latest version of Python and Flask and Vuejs

Clone the repository:

$ git clone https://github.com/superrcoop/weconnec.git

Go into the repository:

$ cd weconnec

Install dependencies:

$ pip install -r requirements.txt

Deploy

To test locally,Ensure that PostgreSQL is installed and running and configure the database URI located in __init__.py

Export database URL:

$ export DATABASE_URL=<DATABASE_URL>

Setup database: 

$ python flask-migrations.py db init
$ python flask-migrations.py db migrate
$ python flask-migrations.py db upgrade

Run:

$ python run.py

Running the tests

The pytest framework makes it easy to write small tests, yet scales to support complex functional testing

$ pytest
================== test session starts ===============================
collected 1 items
tests/test_search_engine.py

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

  1. Fork it (https://github.com/yourname/yourproject/fork)
  2. Create your feature branch (git checkout -b feature/feature-name)
  3. Commit your changes (git commit -am 'Add some feature description')
  4. Push to the branch (git push origin feature/featuren-ame)
  5. Create a new Pull Request

License

This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the LICENSE file for details

Authors

Release History