Page Index - AI4Bharat/Shoonya GitHub Wiki

68 page(s) in this GitHub Wiki:

• Home
• Qualities of a good Data Collection Ecosystem
• Challenges faced by Annotators
• Why Shoonya?
• Goals
• Features of Shoonya
• Overview and Demo Video
• Cloning this master repo
• Backend Setup
• Clone the Shoonya-Backend repository from GitHub to your local machine.
• Create a virtual environment for the project. Replace with your preferred environment name.
• Activate the virtual environment. This ensures that the packages you install are isolated from the global Python environment.
• Install all required Python packages listed in the requirements-dev.txt file.
• Set up the environment variables needed for the project by copying the example environment file.
• Generate a new secret key for Django (within the virtual environment):
• Open a Python shell.
• Copy the generated secret key and paste it into the .env file as the value for SECRET_KEY.
• Docker Installation
• Build the Docker containers as defined in the docker-compose-local.yml file.
• Run the containers in detached mode (-d flag). This will start up all the services defined in the Docker Compose file.
• Run Migrations
• The following steps are required only when you run the project for the first time or after making changes to the models.
• Create a superuser for accessing the Django admin interface (required only once).
• Run the Django development server within the Docker container.
• Frontend Setup
• Clone the Shoonya-Frontend repository from GitHub to your local machine.
• Change directory to the newly cloned Shoonya-Frontend folder.
• Install the necessary dependencies for the project.
• The --force flag is used to bypass conflicts with the existing dependencies.
• Start the development server. This will run the frontend application on a local server.
• Communication Forum
• Code of Conduct
• API Endpoints Testing Automation
• Please reload this page
• Email Reports Feature
• Please reload this page
• GIT Branching And Code Management
• Please reload this page
• Locust ‐ Stress Testing Automation
• Please reload this page
• Project Types
• Please reload this page
• Reports in Shoonya
• Please reload this page
• Review Workflow
• Please reload this page
• Shoonya Super Check Workflow
• Please reload this page
• Shoonya Code Structure
• Please reload this page
• Shoonya Dataset Types
• Please reload this page
• Shoonya Demo(public) Instance
• Please reload this page
• Shoonya Deployment
• Please reload this page
• Shoonya FAQ
• Please reload this page
• Shoonya User Manual for Annotators
• Please reload this page
• Shoonya User Roles
• Please reload this page
• Shoonya Workflow
• Please reload this page
• Software Architecture Diagrams
• Please reload this page
• Technology Used
• Please reload this page