seekheart / coder_directory_api Goto Github PK

Need to have a users endpoint to serve user data.
Should support the following:

• see all users' data
• see one particular user's data
• add a new user
• edit a user
• delete a user

Need to have a self documenting api which should have:

• swagger doc

api needs to be secured and should have:

• token endpoint
• JWT tokens will be used to implement Authorization

It would be nice to have a sign-on process using google credentials. As a user I wouldn't want to have to manage so many different accounts.

• Design flow with Google OAuth
• Assess what needs to be changed
• Implement changes
• Implement tests

Need a language resource to support structured choice of programming languages.
Should support:

Engine

• getting all structured/supported programming languages
• editing a programming language
• adding synonyms
• removing synonyms
• searching for a particular programming languages
• registering a new programming language
• deleting a programming language
• check if language is a synonym or duplicate

Resource

• GET all languages
• GET One Language by id
• POST One language by id with validations (synonym/dupes)
• DELETE One language by id
• PATCH One language by id with validations (synonym/dupes)

Need to dockerize api to allow users to run test versions of api.

Mongo Engine errors when collection is empty cause is cursor not returning anything for max_id just need to change exception handling.

need to lay out some starting infrastructure for the project.

• mock data
• travis ci
• structure of project

Need to start writing up the README for the project so it's welcoming to contributors.
Additionally may need to clean up code and doc strings.

Need to clean up code base and make sure doc strings are proper.

Hi, just stumbled upon this randomly. What is this project actually for? If it's an API does it run somewhere? If I have a google account, can I use it for something? It seems to try follow every possible best engineering practice - documents all the methods, says Mongo somewhere, you can run it from docker - but I don't know why, is it just like, a testing ground for software engineering practices?