siruku6/life_recorder

display activity log

life_recorder

Display activity log
In the future, these logs are showed in the form of chart (perhaps...)

1. Requirement

You need to setup these and to enable docker-compose to run.

• docker
• docker-compose

Other Middlewares

• pipenv
• postgresql

*You don't have to setup these Middlewares in your OS, if you build your environment with docker and docker-compose !!

2. Development

How to build development environment?

With Docker

Click here to open! :D

1. Create OAuth 2.0 client
   If it is necessary, please create Google client-id following this article. (Google Cloud / Creating client IDs)

2. Copy .env

   $ cp .env.example .env

   No	Name	Value Example	Note
   1	DEBUG	True	True => Display error detail on browser
   2	SECRET_KEY	xxxxxx...	It is for Django
   3	DB_USER	user	It is username of your postgresql
   4	DB_PASSWORD	password	It is password of your postgresql
   -	-	-	The below variables are optional (not required)
   5	SOCIAL_AUTH_GOOGLE_OAUTH2_KEY	000000000000-....apps.googleusercontent.com	OAuth 2.0 client ID for Google
   6	SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET	xxxxxx...	OAuth 2.0 client secret for Google

3. Execute following commands

   $ docker-compose build
   $ docker-compose up -d
   $ docker attach life_recorder_web_1
   $ docker-compose exec web python manage.py createsuperuser
   >> ** Input information of your superuser! **

4. You can run automated test by this command

   $ docker-compose exec web python manage.py test --debug-mode
   
   # I recommend following options!
   $ docker-compose exec web python manage.py test --debug-mode -v 2 --pdb --keepdb

After building environment

Access to APP

1. You can access to

   • Django Admin
     localhost:8000/admin
   • App Top
     localhost:8000/cms
   • API Root
     localhost:8000/api/v1

2. You can display the sample response of API
   localhost:8000/api/v1/records/?format=json

Adding pip module

If you add any pip module,
then you have to rewrite requirements.txt and rerun docker-compose build,
because pip modules are installed in Docker image according to requirements.txt.

3. Contribution

Before commit or push, please run following checks, and confirm all of them are successful!

1. flake8

   $ docker-compose exec web flake8

2. unittest

   $ docker-compose exec web python manage.py test --debug-mode

life_recorder's Issues

introduce autocomplete for the page to create new activity

To do this, first, it is necessary to add new table like 'template activity'.
And then, introduce following module.

Module

• github
  https://github.com/yourlabs/django-autocomplete-light
• document
  https://django-autocomplete-light.readthedocs.io/en/master/
• qiita(Japanese)
  https://qiita.com/sukobuto/items/2ea0793608c0ca238367

[Authentication] introduce google oauth

$ docker-compose build
$ docker-compose exec web python manage.py makemigrations
$ docker-compose exec web python manage.py migrate

• References
  • Github
    https://github.com/python-social-auth/social-app-django
  • Official Document
    https://python-social-auth.readthedocs.io/en/latest/configuration/settings.html#urls-options
  • Qiita
    https://qiita.com/moi1990sk/items/a849fca7acb29db95508#%E7%B5%90%E6%9E%9C
    https://qiita.com/arly-times/items/1f2b3450541b2be8b3b2
  • Other
    https://wonderwall.hatenablog.com/entry/2018/03/22/001500

# We can replace '--remote staging' to '--app your_heroku_app_name'
$ heroku config:set SOCIAL_AUTH_GOOGLE_OAUTH2_KEY='000000000000-....apps.googleusercontent.com' --remote staging
$ heroku config:set SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET='xxxxxxxxxxxxxxxxxxxxxxxx' --remote staging

And add Environment Variables on web console of CircleCI.

make validation 'start' is set before 'end' in Activity

I would like to invalidate the instance of activity model if start is later than end.
But now, it is not as it.

• reference (written in Japanese)
  https://noumenon-th.net/programming/2019/11/12/django-validation/

[Frontend] introduce some library to display chart

I would like to introduce amcharts as like following articles.

• https://qiita.com/sato235/items/47c2fd245719c1b53196
• https://www.suzu6.net/posts/56-amcharts-samples/

[Logger] enable LOGGING settings

[CircleCI] Introduce building with circleci

enable to use node_modules in python container

Should I replace expressions in Japanese into English?

This repository is forked by the people who are perhaps not Japanese....
I wonder I should replace all expressions from Japanese into English? ( ˘·ω·˘ ).。oஇ.

separate settings file for unittest

references

• https://stackoverflow.com/questions/913549/how-to-unit-test-with-different-settings-in-django
• https://stackoverflow.com/questions/913549/how-to-unit-test-with-different-settings-in-django/30846788#30846788
• https://stackoverflow.com/questions/913549/how-to-unit-test-with-different-settings-in-django/41349685#41349685

[Auth] introduce the feature that pull avatar picture when use google oauth

References

• https://stackoverflow.com/questions/29575713/retrieving-profile-picture-from-google-and-facebook-in-python-social-auth
• https://hodalog.com/python-social-auth-get-google-avatar/
• https://famirror.hateblo.jp/entry/2015/12/18/180000
  This is the sample of php, but it actually shows us how to get picture via Google Oauth

manage.py test needs `--debug-mode`

I would like to run test without --debug-mode if possible.

references

• https://qiita.com/iwamot/items/9ff417af78ae62c7bb76
• https://stackoverflow.com/questions/44160666/valueerror-missing-staticfiles-manifest-entry-for-favicon-ico

[templatetags] implement a sample of custom template tags

https://docs.djangoproject.com/en/3.2/howto/custom-template-tags/
https://djangoproject-jp.vercel.app/doc/ja/1.0/howto/custom-template-tags.html

[CircleCI] get linter to be executed automatically

• linter: flake8
• environment: circleci

[Rest Framework] enable to respond records via 'api'

references

Official document

• Top
• Quick Start
• Tutorial
• API-Guide: Writable nested serializers

Easy tutorial by Japanese

• Django REST Frameworkを使って爆速でAPIを実装する
• [Django REST Framework] View の使い方をまとめてみた

change the type of Record's attribute

Change the type of Record's attribute 'date' from datetime to date

• Reference
  https://www.nblog09.com/w/2019/05/14/django-field/

[Form] Validation error message doesn't appear for the date form of the Record model

[Bug] On activity page, date format is wrong

Current Result

2021-05-4

Expected

2021-05-04

[bug] cannot find template file on `edit_record`

[Authentication] improve authentication flow

We don't need to use the below articles.
But I am not satisfied with the current authentication flow of this app.

References

• Official Document

  • settings/auth
    https://docs.djangoproject.com/ja/3.2/ref/settings/#auth
  • password-validation
    https://docs.djangoproject.com/ja/3.2/topics/auth/passwords/#password-validation

• Qiita

  • Djangoでaccountsアプリケーションを使わずにログイン認証する
    https://qiita.com/momomo_rimoto/items/7edb608d85fda53644db

[CI] introduce automated coverage measuring with codeclimate

[Unittest] introduce `FactoryBoy` for unittest and make a file or a directory for factories

official reference of FactoryBoy

https://factoryboy.readthedocs.io/en/stable/index.html
https://faker.readthedocs.io/en/master/providers.html

other references

• other github sample
  https://github.com/thinkAmi-sandbox/Django_factory_boy_sample/blob/master/myapp/tests/factories.py
• Django + factory_boyで、1対多や多対多のリレーションを持つテストデータを作る
  https://thinkami.hatenablog.com/entry/2016/04/22/233958

[bug] can't find the file to execute flake8 on circleci

Failed CI execution

https://app.circleci.com/pipelines/github/siruku6/life_recorder/158/workflows/48e6a71d-1735-41de-901d-b9377d9e28d7/jobs/451

Additional information

Though I'm not sure why this is, on the branch fix/#74 the CI execution succeeded like this.
https://app.circleci.com/pipelines/github/siruku6/life_recorder/157/workflows/4ff865f2-66d4-4950-9054-c07a207ef028

Maybe the cache is wrong for some reason, for example, because I replaced the docker image working on circleci.

[Pytest] Introduce pytest

[Django] Split the file 'settings.py' by environment

[bug] replace deprecated docker image for circleci

https://discuss.circleci.com/t/legacy-convenience-image-deprecation/41034#python-10

[templatetags] introduce breadcrumb

• sample
  https://stackoverflow.com/questions/826889/how-to-implement-breadcrumbs-in-a-django-template

[Unittest] add tests for api

Tests like followings are expected ....

1. If there is no record, activity and activity_type, then API returns []
2. If there is some record, activity and activity_type, then API returns array of records with key sum_time
sum_time should be equal to the sum of spent_time every date and activity_type

[Django] add and use first CSS on django

[CircleCI] migration in 'heroku deploy' failed because of 'social_django'

https://app.circleci.com/pipelines/github/siruku6/life_recorder/152/workflows/71a7a9de-6051-4253-aa1a-8ded674cdc37/jobs/430

[Docker] pdb can't be used and the other ways for debugging are wanted

enable to select the activity always done (template_activity)

[Heroku] deploy on heroku

Executed commands

$ curl https://cli-assets.heroku.com/install.sh | sh
heroku/7.49.0 linux-x64 node-v12.16.2
$ heroku -v
$ heroku login -i
$ heroku create siruku6-life-recorder --buildpack heroku/python
$ heroku apps

# Set Environment Variables into Heroku OS
# INFO: You must not set next variable !
# $ heroku config:set DISABLE_COLLECTSTATIC=1
$ heroku config:set ENVIRONMENT=HEROKU
$ python
>>> from django.core.management.utils import get_random_secret_key
>>> get_random_secret_key()
'xxxxxxxxxxxxxxxxxxxxxxxx'
>>> exit()
$ heroku config:set SECRET_KEY='xxxxxxxxxxxxxxxxxxxxxxxx'

# Install django-heroku temporarily
#   https://devcenter.heroku.com/ja/articles/django-app-configuration
$ pipenv lock -r > requirements.txt
$ git add requirements.txt
$ git commit -m "updated requirements.txt"

# Deproy Django app on heroku
$ git push heroku heroku:main
$ heroku run python manage.py migrate
$ heroku run python manage.py createsuperuser

*The environment variable DATABASE_URL is set automatically by heroku. So we don't have to set.

[Docker] enable docker-compose up

[README] add description about how to create secret key to README.md

reference:

https://qiita.com/haessal/items/abaef7ee4fdbd3b218f5

[node_modules] introduce jquery and jquery-ui