Skip to content

VishnuKrishnathu/Webletter

Repository files navigation

Webletter server

Table of contents

Routes

  • /api

  • /auth

    • /register-user

      Returns a httpOnly cookie with jwt token if the username and email is available and valid

      METHOD   :   POST
      BODY   :  
      {
          username : String,
          email : String,
          full_name : String,
          password : String
      }
      

      RESPONSE   :

        STATUS_CODE   (400) :   User registeration unsuccessful
        STATUS_CODE   (200) :   User registeration successful

    • /login-user

      Returns 200 status code if the user is autorized

      METHOD   :   POST
      BODY   :
      {
          username : String,
          password : String
      }
      

      RESPONSE   :

        STATUS_CODE   (400) :   User unauthorized
        STATUS_CODE   (200) :   User authorized


Demo

webletter.herokuapp.com/


Built with

  • Python
  • Django
  • Django Rest Framework

Developing

Update .env.example file found in authentication_app and webletter with your owm keys and rename it to .env


Docker

  1. Clone this repo with git git clone https://github.com/VishnuKrishnathu/Webletter.git
  2. cd Webletter
  3. docker build .

Make sure you have python version greater than 3.6.0


Windows


  1. Setup a virtual environtment to run your django project. python -m venv django-project
  2. Once you’ve created a virtual environment, you may activate it.django-project\Scripts\activate.bat
  3. Clone this repo using git
  4. cd django-project/Webletter
  5. Install the dependencies from the requirements.txt file. pip install -r requirements.txt
  6. Run the server python manage.py runserver


Linux


  1. Setup a virtual environtment to run your django project. python -m venv django-project
  2. Once you’ve created a virtual environment, you may activate it.soruce django-project/bin/activate
  3. Clone this repo using git
  4. cd django-project/Webletter
  5. Install the dependencies from the requirements.txt file. pip install -r requirements.txt
  6. Run the server python manage.py runserver

Continuous Integration

We use Gtihub Actions for continuous integration. Check out our built workflows

About

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages