Agora Tutoring - Backend Documentation, SOPs, and Deployment Manual
Project scope
Categories
Cloud technologies Information technology Software development DatabasesSkills
application programming interface (api) git (version control system) codebase websocket heroku environment variables apollo graphql mongodb redis exception handlingProject Goal
Develop detailed backend documentation, standardized operating procedures, and a deployment instruction manual to enhance maintainability, scalability, and efficient operation of Agora Tutoring's platform.
Main Objective
Learners will document backend architecture, create SOPs for key operational processes, and produce a deployment manual detailing the step-by-step process for rolling out updates or new features. This ensures smooth operations and minimizes downtime during releases.
Required Skills
Experience in: Apollo and GraphQL
Scope Flexibility:
We are willing to break the tasks into individual pieces if needed.
Project Activities
Architecture Mapping
- Document the backend architecture, including technologies like Express, Apollo GraphQL, MongoDB, and deployment on Heroku.
- Include visual aids to outline component interactions and dependencies.
API Documentation
- Provide clear documentation for GraphQL APIs, including authentication methods, query structures, mutation processes, and error handling.
SOP Creation
- SOPs for routine operations:
- Managing and scaling MongoDB Atlas and Redis Cloud.
- Monitoring backend processes and addressing performance issues.
- Setting up local development environments.
Security and Compliance
- Include guidelines for secure handling of sensitive data and credentials.
- Ensure alignment with Agora’s privacy policy and terms of service.
Deployment Instruction Manual
- Preparation for Deployment:
- Steps to set up a local staging environment using Heroku and MongoDB Atlas for testing.
- Testing new features with Websockets and GraphQL subscriptions.
- Version Control:
- Using Git workflows to ensure codebase consistency.
- Deployment Steps:
- Detailed instructions for deploying backend updates to Heroku, including:
- Code push via Git.
- Configuring environment variables and secrets in Heroku.
- Managing build pipelines and deployment review.
- Post-Deployment Verification:
- Verifying successful integration using monitoring tools.
- Checklist for testing APIs and real-time features post-deployment.
Testing and Iteration
- Conduct usability tests with developers or learners to identify gaps in the deployment manual and other documents.
- Iteratively refine based on feedback.
Providing specialized, in-depth knowledge and general industry insights for a comprehensive understanding.
Providing access to necessary tools, software, and resources required for project completion.
Scheduled check-ins to discuss progress, address challenges, and provide feedback.
Supported causes
Quality educationAbout the company
Executive Summary:
Agora Tutoring is an online marketplace akin to Kijiji, equipped with a map function similar to Uber, specializing in connecting students with local tutors for in-person educational sessions.
Company Overview:
Agora Tutoring is an online dedicated platform that connects students with local tutors for in-person educational sessions. By focusing exclusively on face-to-face interactions, Agora Tutoring aims to foster a more personalized and effective learning experience. The platform serves as a bridge between students seeking tailored educational support and independent tutors looking for meaningful teaching opportunities in their local areas.
Services:
Agora Tutoring provides a user-friendly web platform where students can search for and connect with tutors across a variety of subjects and educational levels. The service is designed to facilitate in-person tutoring engagements, enabling direct interaction and hands-on learning that virtual platforms cannot replicate.
Business Model:
Agora operates on a subscription-based model where users pay a monthly fee to access the platform and connect with tutors. Tutors, as independent contractors, set their own rates and schedules by connecting through Agora Tutoring. This model ensures a steady revenue stream for the platform while also providing tutors with a consistent flow of potential students.
Target Market:
The platform primarily targets students at all academic levels who prefer or require in-person tutoring to achieve their educational goals. This includes K-12 students, college students, and adult learners seeking professional development or personal enrichment in specific subjects. Parents looking for reliable and accessible tutors for their children are also a key demographic.
Strategic Goals:
Agora Tutoring aims to become the leading provider of in-person tutoring services within local communities. Strategic objectives include expanding its user base, increasing the number of tutors on the platform, and enhancing the overall user experience with features that make scheduling and session management more efficient for both students and tutors.
Competitive Advantage:
Agora Tutoring’s commitment to exclusively in-person tutoring sessions sets it apart in an era where virtual platforms are prevalent. This focus on local, face-to-face interactions not only improves learning outcomes but also builds a sense of community and trust among users. Additionally, the subscription model offers users unlimited access to potential tutoring, providing flexibility and value that single-session fees cannot match.