Project Anuvaad
  • Sunbird Anuvaad Overview
    • Features
  • USE
    • Playbook
    • Video Tutorials
  • LEARN
    • Architecture
    • Technology Stack
    • Repository structure and developers guide
    • Setting up Anuvaad on your own
    • Git branching strategies
    • Anuvaad Module Config Guidelines
  • MODULES
    • Modulewise Appendix
    • Anuvaad Workflow Manager
    • User management
    • Document converter
    • Auditor
    • OCR Content handler
    • Block merger
    • Content Handler
    • Document Digitization
    • File uploader
    • Aligner
    • ETL Translator
    • File translator
    • Anuvaad Zuul Gateway System
    • Anuvaad Translator
    • Tokenizer
    • Analytics
    • NMT
  • Legacy
    • Model Retraining
    • NMT Inference
    • Integration
      • Registration
      • Login and auth token
      • Supported Language pairs and translation models
      • Translate texts
    • Service Contracts
    • API Host Endpoints
  • ENGAGE
    • FAQ
    • KT Videos
    • Source Code Repository
    • Discuss
    • Tools
      • anuvaad-corpus-tools
      • layout-mt-corpus
      • ocr-toolkit
      • anuvaad-ocr-corpus
      • parallel-corpus
      • anuvaad-em
Powered by GitBook
On this page
  • Frontend
  • Additional Commands
  • Backend
Edit on GitHub
Export as PDF
  1. LEARN

Setting up Anuvaad on your own

PreviousRepository structure and developers guideNextGit branching strategies

Last updated 1 year ago

Follow these steps to set up the Anuvaad Web Application on your local machine:

Frontend

  1. Clone the Repository:

    git clone https://github.com/project-anuvaad/anuvaad.git
    
  2. Navigate to the Project Directory:

    cd anuvaad/anuvaad-fe/anuvaad-webapp-webapp
  3. Install Dependencies:

    npm install

    or

    yarn install
  4. Environment Variables: Create a .env file in the root directory of the project and configure the necessary environment variables. You can use the .env.example file as a reference.

  5. Start the Development Server:

    npm start

    or

    yarn start
  6. Access the Application: Once the development server is started, you can access the application by navigating to in your web browser.

Additional Commands

  • Build the Application:

    npm run build

    or

    yarn build
  • Run Tests:

    npm test

    or

    yarn test

Backend

General Guidelines:

  1. Clone the repo and go to the module specific directory.

  2. Run pip3 install -r requirements.txt.

  3. Make necessary changes to config files with respect to MongoDB and Kafka.

  4. Run python3 src/app.py.

Alternatively, modules could be run by building and running Docker images. Make sure configs and ports are configured as per your local setup.

  • Build Docker Image:

    docker build -t <service-name> .
  • Run Docker Container:

    docker run -r <service-name>

Note: Apart from this, the Docker images running in the user's environment could be found .

http://localhost:3000
here