/NitWork

An API with django rest framework

Primary LanguagePythonMIT LicenseMIT

NitWork

An API where user and company can register/login and get a Token that allow them to make comments

Additional description about the project and its features.

Built With

  • DJANGO
  • DJANGO REST FRAMEWORK
  • Django Rest Knox
  • GITHUB ACTIONS
  • VSCODE

Getting Started

Usage

To have this app on your pc, you need to:

  • download or clone this repo:

    • Clone with SSH:
      git@github.com:pariyajebreili/NitWork.git
    
    • Clone with HTTPS
      https://github.com/pariyajebreili/NitWork.git
    
  • In the project directory, you can run:

Create virtual enviroment

Run migrations:

   py manage.py migrate

Run server:

   py manage.py runserver

Endpoints:

    http://127.0.0.1:8000/account/ signup/student/
    http://127.0.0.1:8000/account/ signup/company/
    http://127.0.0.1:8000/account/ login/
    http://127.0.0.1:8000/account/ logout/ [name='logout']
    http://127.0.0.1:8000/account/ logoutall/ [name='logoutall']
    http://127.0.0.1:8000/account/ comapny/dashbord/
    http://127.0.0.1:8000/account/ student/dashboard/
    http://127.0.0.1:8000/account/ student_update/
    http://127.0.0.1:8000/account/ company_update/
    http://127.0.0.1:8000/account/ companies/ [name='company-list']
    http://127.0.0.1:8000/account/ company_detail/<str:identifier>/ [name='company_detail']
    http://127.0.0.1:8000/comment/ send_comment/<int:id_company>/ [name='send_comment']
    http://127.0.0.1:8000/comment/ show_comment/<int:id_company>/ [name='show_comment']

Acknowledgments 🚀

📝 License

This project is MIT licensed.