wmramadan / fastapi-boilerplate Goto Github PK

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

There is no example of how to use websockets in FastAPI

Solution

Create an example of how to work with WebSockets within FastAPI

Alternatives

None

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

Provide a stream of messages that updates from server side events.

Solution

Create SSE end-point which will update messages without refreshing of the end-point.

Alternatives

None

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

It is probably best to lock the packages in the requirements files to a specific version. No locking to specific version numbers can cause inconsistencies and incompatibility in the future.

Solution

Lock packages to specific versions that have been tested. With each boilerplate version iterations the version number may be upgraded after testing.

Alternatives

Testing can be done across different version but this will take too long in CI.

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

PyMongo does not support async MongoDB connections.

Solution

Switch to Motor which supports MongoDB async connections.

Alternatives

None.

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

Tests are currently not separated

Solution

Create separate tests for:

• main
• users
• items
• tasks

Alternatives

None

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

Alembic has not been implemented so there is no way to run migrations.

Solution

Implement Alembic with documentation on how to apply migrations

Alternatives

None

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

Current app has no CORS Middleware

Solution

Add proper CORS middleware to app

Should follow guidelines:
https://fastapi.tiangolo.com/tutorial/cors/

Alternatives

None