Rokuflam / ProjectZero

DRF template for easy start a new project.
2 stars 0 forks source link

ProjectZero

A DRF project to start new projects faster and better.

Table of Contents

Tutorials

Environment set-up

Features

Prerequisites

Make sure you have the following installed on your machine:

Installation

  1. Clone the repository:

    git clone https://github.com/Rokuflam/ProjectZero.git
  2. Navigate to the project directory:

    cd ProjectZero

    If you are using Pycharm, follow documentation to set up poetry env, otherwise follow next steps

  3. Open Poetry shell:

    poetry shell
  4. Generate Poetry lock file

    poetry lock
  5. Install or Update project dependencies:

    poetry install
    poetry update

Configuration

  1. Create a copy of the .env.example file and name it .env. Update the values as needed.

  2. If you need a Social Auth, go to backend/apps/user/fixtures/social-auth.json, and change client_id for the app you are about to use.

  3. If you need Anymail, fill variables from example.env into your env file, and choose EMAIL_BACKEND in backend/config/settings/{env you use}.py

Usage

API Documentation

  1. Swagger /api/docs/
  2. Admin panel /admin/

Acknowledgments