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.
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
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
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
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.
- Fork it (https://github.com/yourname/yourproject/fork)
- Create your feature branch (
git checkout -b feature/feature-name) - Commit your changes (
git commit -am 'Add some feature description') - Push to the branch (
git push origin feature/featuren-ame) - Create a new Pull Request
This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the LICENSE file for details
- 0.1.0
- The first real release
- Launch site ui/ux with minimal search capabilities
- 0.0.1
- Work in progress