Set Up Your Development Environment¶
Setting up your development environment for the Trustworthy and Ethical Assurance (TEA) Platform involves configuring both the backend and frontend components. This guide will walk you through the necessary steps to get your local development environment up and running. It's important to set up the backend before proceeding with the frontend to ensure that the frontend can communicate with the backend services.
Note
A quicker way to get the TEA Platform running on your local machine is to use Docker. If you're familiar with Docker and docker-compose, you can follow the Docker Quick Start guide to set up the platform with minimal effort.
Prerequisites¶
Before starting the setup process, ensure you have the following prerequisites installed on your system:
Backend Prerequisites¶
Before you begin setting up the backend, it's essential to have a proper Python environment management system in place. For this setup, we recommend using Anaconda or Miniconda, which are powerful platforms for managing Python environments and packages. Anaconda is a full-featured distribution that includes a wide range of scientific libraries and tools, making it ideal for data science and machine learning projects. Miniconda is a minimal installer for Anaconda, offering the same environment and package management capabilities but allowing you to install only the packages you need. Both options provide a convenient way to create isolated environments for different projects, ensuring dependencies are kept separate and do not conflict.
If you don't already have Anaconda or Miniconda installed, please visit their respective websites for installation instructions tailored to your operating system. This will streamline the process of creating a virtual environment and managing the necessary Python packages for the TEA Platform backend.
Frontend Prerequisites¶
Node.js and npm: Ensure you have Node.js and npm installed on your system. Node.js is a runtime environment that allows you to run JavaScript on the server side. npm, included with Node.js, is the world's largest software registry that facilitates package management for JavaScript.
Backend Installation¶
The backend of the TEA Platform is built with the Django framework and provides the API endpoints necessary for the frontend application to function.
For detailed instructions on setting up the backend, including configuring the database and running the Django development server, refer to the Backend Installation page.
After setting up the backend, you can proceed with the frontend setup.
Frontend Installation¶
The frontend application is developed using the React framework, enabling dynamic user interactions and a responsive design.
The frontend setup involves installing npm dependencies and running the development server. For step-by-step guidance, visit the Frontend Installation page.