Skip to main content

Introduction

Welcome to the Placement Assistance Web App developer documentation! This documentation is intended for setting up the development environment and understanding the codebase.

A project made of composition of multiple technologies, and these technologies are:

  • React - Frontend Framework (UI and UX)

  • Express - Web Application Framework (Client-Server Communication with Django API)

  • Django - Backend Framework (Django with Django REST Framework API)

Prerequisites​

Before you start, make sure you have the following:

Environment​

  • Node.js - JavaScript runtime environment (Node.js version 18.x >= latest)
  • Python - Programming language (Python version 3.9.x >= higher)

IDE (Integrated Development Environment)​

Any IDE of your choice, but we recommend the following due to their popularity and ease of use:

Database​

You can use any database, however, the documentation uses the by default database that comes with Django, which is SQLite. It is discussed in the Database section.

Git​

  • For Mac and Linux users, Git is already installed.

  • For Windows users, you can download it from here. or you can use Git Bash CLI.