Skip to content

AgnieszkaPlatek/Forget_It_Not_v2-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Forget-It-Not - BACKEND

I am working on this project during mentorship DareIT programme, It is supervised by my mentor Kasia Jagieła.

It is a backend Django API for Forget-It-Not application.

Table of contents

General info

Django API designed for Forget-It-Not aplication, designed to cooperate with Forget-It-Not FRONTEND, to create Forget-It-Not application for learning languages and repeating new words (or other things like capitals or dates).

Technologies

  • Python 3.9.1
  • Django 3.1.5
  • Django Rest Framework 3.12.2

Status

Project is: in progress

Features

  • Endpoints concerning users authentication and registration, provided by Djoser library
  • CRUD endpoints for flashcard-sets and flashcards
  • Endpoints specially designed for frontend: for listing, searching and learning flashcards

Examples of usage

axios .get("flashcard-sets/") .then( (response) => ( (this.sets = response.data), (this.num_sets = response.data.length) )).catch((error) => console.log(error));

axios({ method: "delete", url: "flashcards/" + this.flashcard.id }).catch((err) => { console.log("error in request", err); });

Installation and Setup

Install Python 3.9 from https://www.python.org/downloads/
Install git from https://git-scm.com/downloads

Clone the repository:

git clone https://github.com/AgnieszkaPlatek/Forget_It_Not_v2-backend.git
cd Forget_It_Not

Create virtual environment:

python -m venv venv

Activate the virtual environment on Windows or Linux:

venv\Scripts\activate  or  source venv/bin/activate

Install requirements:

pip install -r requirements.txt

Change following settings as follows or set your own environment variables in your system and check email configuration:

DEBUG = True
SECRET_KEY = '<your-secret-key>'
EMAIL_HOST = 'smtp.gmail.com'
EMAIL_PORT = 587
EMAIL_USE_TLS = True
EMAIL_HOST_USER = '<your-email>'
EMAIL_HOST_PASSWORD = '<your-email-password>'
guest_password = '<your-guest-user-password>'

Run migrations and server:

python manage.py migrate 
python manage.py runserver

Open http://localhost:8000 in the browser.

About

Backend API for my DareIT mentorship project.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages