cosmas28 / business-connect-v2 Goto Github PK

WeConnect provides a platform that brings businesses and individuals together. This platform creates awareness for businesses and gives the users the ability to write reviews about the businesses they have interacted with.

To set up WeConnect API, make sure that you have python 3.6 or more, postman and pip installed.

• Clone the Repo into your local directory.

$ git clone https://github.com/cosmas28/business-connect-v2.git

• create a virtual environment.

$ virtualenv <your_virtualenv>

• Activate your virtual environment

Navigate to the API directory.

$ cd business-connect-v2

To install the packages run pip install -r requirements.txt

• Install PostgreSQL.
• Create a new database.
• Change Database configuration at SQLALCHEMY_DATABASE_URI environment variable to include your database name, password and user name i.e SQLALCHEMY_DATABASE_URI = 'postgresql://<username>:<password>@localhost/database_name'

• Run migrations initialization using this command $ python manage.py db init
• Run actual migrations using $ python manage.py db migrate
• Finally apply migrations using $ python manage.py db upgrade
• Then each time the database models change repeat the migrate and upgrade commands.

$ python manage.py runserver

• Run the server $ python manage.py runserver
• Browse http://localhost:5000/apidocs/

Run the endpoints on Postman

Run the test using bash

$ pytest

Run the API endpoints using the following URLs

• Andela Kenya Recruitment team for inspiration