Quest Submission APIs

Brief

Code-quests is a platform that helps businesses publish projects (called Quests) and ask a community of developers and designers to compete to build the best, highest-quality implementation or design.

In this quest, the goal is to build a high-quality RESTful API  that powers part of this platform.

Requirements

1. Use TypeScript, Node.js LTS, Feathers.js

2. Automatically generated OpenApiSpec (OAS) must be generated automatically, using feathers-swagger  or any other alternative. Note that Models Schema can be automatically generated using sequalize-to-json 

3. PostgreSQL Database, with Code first migrations (database generated from code)

4. Follows 12-Factor App  principles, including accepting configurations using Environment Variables, including DB connection string.

API Resources

A detailed Design document will be shared with competitors after they register, the document will contain details about the REST APIs and the Database models.

1. Registration

2. Submission

3. Quest Comments

Tasks

A detailed Design document will be shared with competitors after they register, the document will list the detailed use cases as follows:

1. Filtering and finding quests 

2. Registration Rules.

3. Submission Rules

4. Comments Rules

Out of Scope

These features are out of scope for this quest and will be built in future quests isA.

1. Lifecycle management of Quests or Reviews or Prizes (nothing automatically happens on dates)

2. Review management and notifications.

3. Scorecard management

4. Submission file upload and management

Acceptance Criteria

Please read the Backend Scorecard to see how the winners will be selected, and how we evaluate the best code submission.

• Minimum acceptable score is 80 (80% of 100). First, Second, Third place will be the highest score above 80.

• If two submissions earn the same score, the first submission will get the highest place.