{"id":29011255,"url":"https://github.com/alexmochu/weconnect-api-v2","last_synced_at":"2026-05-18T05:48:31.362Z","repository":{"id":31313086,"uuid":"127525441","full_name":"alexmochu/weConnect-API-v2","owner":"alexmochu","description":"(Data Persistence - API {Back-end}) 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. ","archived":false,"fork":false,"pushed_at":"2022-12-08T02:05:43.000Z","size":106,"stargazers_count":1,"open_issues_count":9,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-08T13:40:29.777Z","etag":null,"topics":["flask","jwt-tokens","postgresql-database","python-3-6","restful-api"],"latest_commit_sha":null,"homepage":"https://weconnect-v2-heroku.herokuapp.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexmochu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-31T11:17:01.000Z","updated_at":"2019-10-29T16:46:29.000Z","dependencies_parsed_at":"2022-08-27T17:20:57.645Z","dependency_job_id":null,"html_url":"https://github.com/alexmochu/weConnect-API-v2","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/alexmochu/weConnect-API-v2","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexmochu%2FweConnect-API-v2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexmochu%2FweConnect-API-v2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexmochu%2FweConnect-API-v2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexmochu%2FweConnect-API-v2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexmochu","download_url":"https://codeload.github.com/alexmochu/weConnect-API-v2/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexmochu%2FweConnect-API-v2/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281185436,"owners_count":26457746,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-26T02:00:06.575Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","jwt-tokens","postgresql-database","python-3-6","restful-api"],"created_at":"2025-06-25T17:12:09.052Z","updated_at":"2025-10-26T22:34:57.428Z","avatar_url":"https://github.com/alexmochu.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d2bb80729b76446e85540300e4af348d)](https://www.codacy.com/app/alexmochu/weConnect-API-v2?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=alexmochu/weConnect-API-v2\u0026utm_campaign=Badge_Grade)\n[![Maintainability](https://api.codeclimate.com/v1/badges/d5c2e3a5f81cba46d514/maintainability)](https://codeclimate.com/github/alexmochu/weConnect-API-v2/maintainability)\n[![Build Status](https://travis-ci.org/alexmochu/weConnect-API-v2.svg?branch=master)](https://travis-ci.org/alexmochu/weConnect-API-v2)\n[![Coverage Status](https://coveralls.io/repos/github/alexmochu/weConnect-API-v2/badge.svg?branch=master)](https://coveralls.io/github/alexmochu/weConnect-API-v2?branch=master)\n\n# weConnect-API-v2\n\nWeConnect 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.\n\n# Technology Used\n\nThe API has been built with:\n\n- Flask micro-framework (Python 3.6)\n- Postgresql Database\n- JSON Web Tokens\n\n# UI templates and API Documentation\n\n- To preview the UI, proceed to https://alexmochu.github.io .\n- The \u003ca href=\"https://github.com/alexmochu/alexmochu.github.io\"\u003eUI Templates\u003c/a\u003e have been hosted on Github Pages\n- To access the API hosted on the Heroku cloud platform --\u003e\u003e https://weconnect-v2-heroku.herokuapp.com/\n- Access the API documentation at \"https://weconnectv2.docs.apiary.io\"\n\n# Features\n\n1.  Users can be able to register and create an account\n2.  Registered users can be able to log in\n\n# Installation\n\n1. Ensure you have installed Python3.6+, created and an activated a virtual environment.\n2. Clone the repo in your local machine inside the virtual environment you have created.\n3. Navigate to the project folder(WeConnect-API-v2)\n4. Install all the requirements of the project by typing:\n   `pip install -r requirements.txt`\n\n# Running the API\n\n## Make Migrations\n- Create this folder and file inside the main folder `/instance/config.py` add this two lines \n\n`SECRET_KEY = 'your_secret_key_here'` \n`SQLALCHEMY_DATABASE_URI = 'your_postgres_database_uri'`\n\n- Type in terminal:\n`flask db init`\n`flask db migrate`\n`flask db upgrade`\n\n- NOTE: While on development uncomment line 20 and comment line 19 `/app/__init__.py` file. Reverse this while on production.\n\n- Type in terminal:\n  `export FLASK_CONFIG=developmemt`\n  `export FLASK_APP=run.py`\n  `flask run`\n\n# Running the Tests\n\n# API Endpoints\n\n| Resource URL                                          | Methods | Description                                        |\n| ----------------------------------------------------- | ------- | -------------------------------------------------- |\n| /api/v2/auth/register                                 | POST    | User Registration                                  |\n| /api/v2/auth/login                                    | POST    | User Login                                         |\n| /api/v2/auth/reset-password                           | PUT     | User can be able to reset password                 |\n| /api/v2/auth/logout                                   | DELETE  | Logs out User                                      |\n| /api/v2/category                                      | POST    | Create a business category                         |\n| /api/v2/category/all                                  | GET     | Retrieve all created categories                    |\n| /api/v2/category/\u003ccategory_id\u003e                        | PUT     | Updates a business category                        |\n| /api/v2/category/\u003ccategory_id\u003e                        | DELETE  | Deletes a business category                        |\n| /api/v2/\u003ccategory_id\u003e/business                        | POST    | Create a business with unique ID and business name |\n| /api/v2/business/all                                  | GET     | Retrive all business created                       |\n| /api/v2/business/\u003cbusiness_id\u003e                        | GET     | Retrive a business by ID                           |\n| /api/v2/business/\u003cbusiness_id\u003e                        | DELETE  | Remove a business                                  |\n| /api/v2/\u003cbusiness_id\u003e/review                          | POST    | Add a review for a business                        |\n| /api/v2/reviews/all                                   | GET     | Get all reviews                                    |\n| /api/v2/reviews/all/page=\u003cint:page\u003e                   | GET     | (Paginantion)Get all reviews                       |\n| /api/v2/reviews/all/page=\u003cint:page\u003e\u0026limit=\u003cint:limit\u003e | GET     | (Paginantion)Get all reviews                       |\n\n# Pagination\n\n| Resource URL                                           | Methods | Description                                  |\n| ------------------------------------------------------ | ------- | -------------------------------------------- |\n| /api/v2/category/all/page=\u003cint:page\u003e                   | GET     | (Paginantion)Retrieve all created categories |\n| /api/v2/category/all/page=\u003cint:page\u003e\u0026limit=\u003cint:limit\u003e | GET     | (Paginantion)Retrieve all created categories |\n| /api/v2/business/all/page=\u003cint:page\u003e                   | GET     | (Paginantion)Retrive all business created    |\n| /api/v2/business/all/page=\u003cint:page\u003e\u0026limit=\u003cint:limit\u003e | GET     | (Paginantion)Retrive all business created    |\n\n# Searching\n\n| Resource URL                | Methods | Description          |\n| --------------------------- | ------- | -------------------- |\n| /api/v2/search?q=\u003cbusiness\u003e | GET     | Search Business by q |\n\n# Searching and Filtering\n\n| Resource URL                                                        | Methods | Description                              |\n| ------------------------------------------------------------------- | ------- | ---------------------------------------- |\n| /api/v2/search?q=\u003cbusiness\u003e\u0026location=\u003clocation\u003e\u0026category=\u003ccategory\u003e | GET     | Filter Business by Location and Category |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexmochu%2Fweconnect-api-v2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexmochu%2Fweconnect-api-v2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexmochu%2Fweconnect-api-v2/lists"}