ltn0tbug / WebAppSecProject

A project of WebAppSec subject. WIP btw 🙃

WebAppSecProject - Alunno

WIP btw 🐧🐧🐧

What is Alunno?

Alunno is a web-based course management application for WebAppSec course which uses Django and React.

🚀 Fast

🎨 Beautiful interface

🛡️ Super Duper Secure

🌎 Multilingual

Getting Started

Prerequisites

• Python: ^3.10.0
• Nodejs: 16.15.0

Environment variables

• Use .env.local to store your secrets (*.local files is ignored). Ex: Django secret key, ...
• Use .env to store other variables.
• .env* files should place in backend or frontend folder.

Code formatting

After setup, you can format code with the following command:

• Backend:

  black { your file or folder } # Python only

  • Ex: If your current directory is backend, you can run:

    black .

• Frontend

  pnpm format

Django secret key

After setup, if you want to generate new Django secret key, you can run:

manage.py djecrety

Setup

1. Get the source code

git clone https://github.com/ducluongtran9121/Web-Application-Project.git
cd Web-Application-Project

2. Set up

• Set up backend

  • Create environment

    cd backend
    python -m venv .venv # Or python3

  • Active environment

    .venv\Scripts\Activate.ps1 # Powershell
    .venv\Scripts\activate.bat # Command Prompt
    .venv\Scripts\activate # Unix

  • Install dependencies

    pip install -r .\requirements.txt

  • Add your secret key

    echo "DJANGO_SECRET_KEY={ Your secret key }" > .env.local

  • Migrate

    python manage.py makemigrations
    python manage.py migrate

• Set up frontend

  • Install dependencies

    cd frontend
    pnpm i

Run

• Backend

  python manage.py runserver

• Frontend

  • To run dev server

    pnpm dev

  • To build the app

    pnpm build

Tech Stack

• Backend

  • Python
  • Django
  • Django REST

• Frontend

  • TypeScript
  • React
  • Mantine

• Love ❤️

Teams

Ngo Duc Hoang Son 💻 📖 🎨 🚧

thihuynhdotexe 💻 🚧 📆

janlele91 💻 🚧 📆