chrisdecleene / cb-code-quiz-rest-api

CB-Code Quiz App REST API

In an effort to grow as developers and learn in a production setting, we are building a fully-functional REST API for coding Quizzes using a TDD approach (test-driven development) and MVC (model-view-controller) pattern. Live demo here.

Table of Contents

• General Info
• Technologies Used
• Features
• Screenshots
• Setup
• Usage
• Project Status
• Room for Improvement
• Acknowledgements
• Contact

General Information

• Provide general information about your project here.
• What problem does it (intend to) solve?
• What is the purpose of your project?
• Why did you undertake it?

Technologies Used

Features

List the ready features here:

• POST /api/quiz
• POST /api/quiz/:topicId/question
• GET /api/quiz/:topicId
• GET /api/quiz/:topicId/question/:questionId
• PUT /api/quiz/:topicId
• PUT /api/quiz/:topicId/question/:questionId
• DELETE /api/quiz/:topicId
• DELETE /api/quiz/:topicId/question/:questionId

Screenshots

Setup

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Usage

How does one go about using it? Provide various use cases and code examples here.

write-your-code-here

Project Status

Project is: in progress / complete / no longer being worked on. If you are no longer working on it, provide reasons why.

Room for Improvement

Include areas you believe need improvement / could be improved. Also add TODOs for future development.

Room for improvement:

• Improvement to be done 1
• Improvement to be done 2

To do:

• Feature to be added 1
• Feature to be added 2

Acknowledgements

• This project was made with Codecademy as part of the Full Stack Engineering Career Path

Contact

Created by Chris DeCleene - feel free to contact me!