DOCSEARCHbyAlgolia
Submit Docs

Placement Assistance Web App Documentation

website·Indexed 31 days ago

https://docs-placement-webapp.vercel.app/

Documentation for the Placement Assistance Web App, featuring a user guide for account registration and system usage, and a developer guide covering project structure, API information, and setup instructions for the frontend, backend, and database.

Tokens
2.5K
Snippets
14
Records
30
Agent score
75%

What's inside Placement Assistance Web App

  1. Overview of API endpoint categories

    The API is organized into three primary functional areas:

    • Accounts: User management and authentication.
    • Placement Applications: Creating, updating, deleting, retrieving, and reviewing placement application forms.
    • Placements: Managing approved placements (retrieving, updating, deleting, and listing).

  3. Overview of the Placement Assistance Web App technology stack

    The Placement Assistance Web App is built using a composition of three primary technologies: React for the frontend UI/UX, Express as the web application framework for client-server communication with the Django API, and Django (with Django REST Framework) for the backend API.

  4. Overview of the Placement Assistance Web App

    The Placement Assistance Web App is a web-based platform designed for the University of Leicester's placement department to simplify and enhance the approval and supervision of students on placement. It serves as a centralized hub connecting three primary stakeholders: Students, Placement Tutors (UoL placement department), and Placement Providers (Employers). The system aims to automate essential procedures, eliminate manual paperwork, and reduce errors in the placement process.

  5. Overview of the Digitalised Placement Assistance System

    The Digitalised System automates the entire placement assistance lifecycle, covering all stages from initial student registration to final placement. This digitization replaces manual paperwork with digital workflows to streamline the process for both students and administrators.

  6. Manage user accounts in the Placement Assistance Web App

    The User Account section of the Placement Assistance Web App provides tools for identity and profile management. Available features include:

    • Registration: Create new accounts for Students, Employers, or Tutors.
    • Authentication: Login and Logout functionality.
    • Account Recovery: Resetting forgotten passwords.
    • Account Activation: Activating a new account or requesting a resend of the activation email.

  8. Understand the Backend project structure

    The backend is located in the /backend directory and is powered by a Django server.

    • Dependencies: All Django server dependencies are listed in the requirements.txt file located at the project root.
    • App Organization: The backend is divided into two main module directories:
      • /apps: Handles data models and database migrations.
      • /api: Handles the API endpoints.

  9. Understand the Frontend project structure

    The frontend is located in the /frontend directory and is split into two parts: an Express server and a React application.

    • /frontend: Contains the package.json and package-lock.json files used to manage dependencies for the Express server.
    • /frontend/client: Contains the React application, including its own package.json and package-lock.json for React-specific dependencies.

  10. Use MySQL or PostgreSQL with Django ORM

    The project supports any database compatible with Django ORM, including MySQL and PostgreSQL. To switch from the default SQLite setup to one of these databases, follow the official Django database documentation to configure the appropriate engine and credentials in settings.py.