sukhrobjon/profiles-rest-api

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:

• Heroku
• AWS

Available Endpoints

Base URL: http://ec2-13-59-212-52.us-east-2.compute.amazonaws.com/api/

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

Built With

• Django - Python Web framework
• Django Rest Framework - Tool for Web APIs
• AWS - Amazon Web Services, Cloud computing platforms
• Heroku - Cloud Platform

profiles-rest-api's Issues

Nathan's Project Review of the profile REST API

Done Well

—————————————

• Project is well organized/architected
• Variables are clear and semantic,
• Clear, semantic variable names and conventions are consistently followed.
• Code is well modularized
• Great knowledge of standard libraries that simplifies complex features.
• README clearly states use, intent, and context of the application

Could improve

—————————————

• Testing for this project does not exist.
• The project would benefit from testing endpoints, input/output, and exception handling

Readability and Formatting : 3
Organization and Modularity: 3
Standard Library/Conventions: 3
Effectiveness of Solution: 3
Testing and Error Handling: 0
Algorithmic Complexity: 3

Total: 15/18