Git Product home page Git Product logo

social_networking_rest_apis's Introduction

Django App for Social_Networking

=======

This app provides below functionalites:

  • New user registration
  • Login
  • Apis to search users by username or email.
  • Apis to send, accept and reject friend requets.
  • List pending friend requests of a user.
  • List accepted friend requests of a user.
  • List rejected friend requests of a user.
  • Api throttling (Rate limit)

Check this document for apis request and response samples. For high level understanding visit(https://rb.gy/p6j9ig)

Exceot login and signup all apis are for authenticated users. They need to send jwt token to autheticate them.

fde99e4 (Updated readme file)

Step 1 - Clone the repo

git clone https://github.com/abhishek-sanwal/Social_Networking_rest_apis.git

If Docker Dekstop app is installed on your machine.

Step 2- Go to the directory where docker-compose.yaml file is present and run projetc in docker container.

docker-compose up

Now server should be started at local host port 8000 .Now you can test apis.

To stop the docker container

docker-compose down

If docker Dekstop is not instlled simply create a virtual enviroment using python

Step 2 - Create virtual enviroment using python

  • For Windows and Linux

     python -m venv <enviroment_name>
    
    
  • For Macos

    ```
     python3 -m venv <enviroment_name>
    ```
    

    Step 3 -> Activate virtual enviroment

  • For Macos and Linux

     source <enviroment_name>/bin/activate
    
    
  • For Windows

        <enviroment_name>/Scripts/activate
    
    

Step 4: Install requirments from requirments.txt file

pip install -r requirments.txt

Step 5 : Run below commands to start server

  • For Macos and Linux

    python3 manage.py makemigrations
    python3 manage.py migrate
    python3 manage.py runserver
    
  • For Windows

    python manage.py makemigrations
    python manage.py migrate
    python manage.py runserver
    

Now server should be started at local host port 8000

Now you can test apis.

social_networking_rest_apis's People

Contributors

abhishek-sanwal avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.