Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Set up the django project #1

Closed
wants to merge 17 commits into from
Closed

feat: Set up the django project #1

wants to merge 17 commits into from

Conversation

frgfm
Copy link
Member

@frgfm frgfm commented Oct 2, 2020

This PR aims at setting up the django project by:

  • settings up a basic django project structure
  • adding a first app "user"
  • adding CI jobs for lint checking, deps installation, doc building, doc deployment, docker container tests

Here is how the documentation renders:
api_docs

Also, once the django server is run, it can be easily accessed using postman:
api_postman

As of now, I only implemented the project structure with a user app and its model but no views yet. I'll open up another PR to set the other apps (models).

Any feedback is welcome!

@frgfm frgfm added topic: docs Improvements or additions to documentation type: improvement New feature or request topic: build Related to build, installation & CI endpoint: users labels Oct 2, 2020
@frgfm frgfm added this to the 0.1.0 milestone Oct 2, 2020
@frgfm frgfm self-assigned this Oct 2, 2020
@fe51
Copy link
Member

fe51 commented Oct 2, 2020

Thank you for all this set up and first feature !

I think having multiple apps is a good point to keep the project structured !
However, in the long term, to keep things clear, we also could have a urls.py file per app. To get started, it suits me !

@frgfm frgfm requested review from Akilditu and blenzi October 2, 2020 16:20
@frgfm frgfm requested review from MateoLostanlen and x0s October 2, 2020 16:20
@frgfm frgfm added the wontfix This will not be worked on label Oct 6, 2020
@frgfm
Copy link
Member Author

frgfm commented Oct 6, 2020

Replaced by #2 using a FastAPI implementation

@frgfm frgfm closed this Oct 6, 2020
@frgfm frgfm deleted the django-setup branch October 7, 2020 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
endpoint: users topic: build Related to build, installation & CI topic: docs Improvements or additions to documentation type: improvement New feature or request wontfix This will not be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants