Skip to content

Sukhrobjon/profiles-rest-api

Repository files navigation

Profiles-Rest-API

This api can be usefull as it uses the very common architecture in social media, or any other platform where user has profile and status. This can be used as an api of the users' dashboard You can find the more in Proposal

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.

Prerequisites

Make sure you have Python3 installed in your machine.

Installing

A step by step series of examples that tell you how to get a development env running

  1. Clone the repo git clone https://github.com/Sukhrobjon/profiles-rest-api.git

  2. Go to folder cd profiles-rest-api

  3. Now Install venv inside root of project folder virtualenv -p python3 venv

  4. activate venv source venv\bin\activate

  5. pip install the dependencies in requierements.txt file using pip install -r requirements.txt

Deployment

The app is live on following servers:

Available Endpoints

Method Resources Return Object
GET /profile All Users
GET /profile/:id Specific user
GET /feed All feeds
GET /feed/:id Specific feed

Built With

Releases

No releases published

Packages

No packages published