https://github.com/ankitborude/abacus-exam-system-rest-api

The Abacus Exam API is a comprehensive platform designed to streamline mathematical assessment and practice for educational institutions.
https://github.com/ankitborude/abacus-exam-system-rest-api

api caching endpoint-engineering exam expressjs generator http-server javascript joi-validation jspdf jwt mongodb mongoose morgan nodejs oauth2 rest-api restful-api winston-logger

Last synced: 1 day ago
JSON representation

The Abacus Exam API is a comprehensive platform designed to streamline mathematical assessment and practice for educational institutions.

• Host: GitHub
• URL: https://github.com/ankitborude/abacus-exam-system-rest-api
• Owner: AnkitBorude
• License: apache-2.0
• Created: 2024-09-06T08:41:24.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2025-01-12T08:42:49.000Z (14 days ago)
• Last Synced: 2025-01-12T09:30:28.076Z (14 days ago)
• Topics: api, caching, endpoint-engineering, exam, expressjs, generator, http-server, javascript, joi-validation, jspdf, jwt, mongodb, mongoose, morgan, nodejs, oauth2, rest-api, restful-api, winston-logger
• Language: JavaScript
• Homepage: https://ankitborude.github.io/Abacusexam-documentation/
• Size: 305 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
🚀 Abacus Exam REST API

  


    

    

    

  

  
A secure, scalable REST API built with Node.js, Express, and MongoDB for managing and conducting online exams efficiently. This API provides robust features like authentication, question generation, analytics, and more.







  
✨ Features



  

    🔒 OAuth Security

    ⚙️ RBAC

    📊 Analytics

  

  

    📑 Smart Question Generation

    🔄 Cookie-Free Architecture

    🌐 Cloud Optimized

  



  
🛠️ Tech Stack



  

    Category

    Technologies

  

  

    Server

    

  

  

    Framework

    

  

  

    Database

    

  

  

    Packages

    

      randomjs, jsPDF, mongoose, winston, morgan, joi, helmet, dotenv, bcryptjs

    

  



  
🔧 Installation



For installation and setup instructions, please refer to the API Documentation.



  
📜 API Documentation



Find the comprehensive API documentation here.



  
📊 Testing and Coverage



The API is end-to-end tested on Postman with approximately 80% code coverage. Explore the Postman workspace here.



  
📜 Scripts




"scripts": {

    "test": "echo \"Error: no test specified\" && exit 1",

    "start": "NODE_ENV=production node ./src/index.js",

    "dev": "nodemon ./src/index.js",

    "prof": "node --prof ./src/index.js",

    "lint": "npx eslint .",

    "lint:fix": "npx eslint . --fix",

    "format:check": "npx prettier . --check",

    "format:fix": "npx prettier . --write",

    "db:dump": "node ./scripts/mongo-dump.js dump",

    "db:restore": "node ./scripts/mongo-dump.js restore"

}





  
🤝 Contributing



Contributions are welcome! Feel free to fork the repository, make changes, and submit a pull request. Ensure your code follows the project style guidelines and includes tests.



  
⚖️ License



This project is licensed under the Apache 2.0 License.