https://github.com/miku0129/qfb-tokyo
Manage a list of book titles 📚 🌈
https://github.com/miku0129/qfb-tokyo
firebase flask python
Last synced: 2 months ago
JSON representation
Manage a list of book titles 📚 🌈
- Host: GitHub
- URL: https://github.com/miku0129/qfb-tokyo
- Owner: miku0129
- Created: 2021-10-19T09:38:42.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-25T22:31:24.000Z (over 3 years ago)
- Last Synced: 2025-07-03T15:11:12.156Z (about 1 year ago)
- Topics: firebase, flask, python
- Language: Python
- Homepage:
- Size: 213 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project - Book list 📚
#### About
---
As a final project deliverable for CS50x, I created a full-stack app to manage the book lists for the book club I belong to.
CS50x の最終課題として、所属するブッククラブで本のリストを管理するためにフルスタックのアプリを作成しました。
I did this project from 2021/10/17 to 2021/11/7.
作成期間は 2021/ 10/17 から 2021/11/7 です。
#### Video Demo: https://youtu.be/LKHt2ZldNg0
#### Tech
---
- Python 3.10.10
- pipenv, Flask
- Firebase for Firestore and Authentication.
- Heroku
#### Structure
---
MCV model
- M, Data is stored in Firestore - Firebase
- C, Python and Flask manage data between the database and the view
- V, jinjya provide templates for the view
app.py contains main functions to contlolle model and view. It also initialized Firebase_admin to use Firestore and autentication.
helpers.py contains functions which be used in app.py. I sepalated functions to make them readable.
Pipfile and Pipfile.lock stores information about dependencies of my projects.
Prockfile, requrements.txt and runtime.txt contains information to deploy my project to Heroku.
MCV model
- M, データはFirestore - Firebaseに保存されています
- C, PythonとFlaskがデータベースとビューの間のデータを管理します
- V, jinjyaはビューのためのテンプレートを提供します
app.pyには、モデルとビューを接続するための主要な関数が含まれています。また、Firebase_adminを初期化し、FirestoreとAutenticationを使用しています。
helpers.py は app.py で使用される関数を含んでいます。読みやすいように関数を分けています。
PipfileとPipfile.lockは、私のプロジェクトの依存関係についての情報を格納しています。
Prockfile, requrements.txt, runtime.txtには、Herokuにプロジェクトをデプロイするための情報が格納されています。
#### Development
---
```
#### 1. アプリ起動
Python仮想環境を起動
pipenv shell
仮想環境内にてFlaskサーバー起動
flask run
#### 2. アプリ開発
1) 開発一般
仮想環境内にてライブラリのインストール
pipenv install [ライブラリ名]
バージョン管理は git コマンドで行う
開発は developブランチ,
本番は mainブランチで管理する
デバッグは VSCodeのデバッグ画面を開き
任意の場所にブレークポイントを張り
デバッグ実行ボタンを押下する。
その際には
仮想環境を閉じておくこと,
デバッグしたいフォルダをフォーカスすること。
デバッグ終了時コマンドは
deactivate
2) デプロイ
ヘロクにログインする
heroku login
デプロイ
git checkout main // ローカルのメインに移動
git pull main // リモートのメインから最新のコードを取得する
git push heroku main //ヘロクにデプロイする
デプロイしたページを開く
heroku open
#### 3. アプリ停止
Flaskサーバーの起動停止
ctrl + C
Python仮想環境を起動停止
exit
```
#### Description:
---
The first challenge was that creating an environment for creating a product. Since I'd like to minimize my project, I needed to set up for my VSCode to debug.
The second challenge was that finding the reason why libraries I installed was not found by terminal. I found that it was because different Python was used in VSCode and terminal if I installed several different version of Python.
The third challenge was that finding the way to implement creck event in Python. Since I thought it's important for a better user experience, I spent a time to research how to implement a button to vote a book. Then I decided to use jQuery and ajax.
To solve those issues, I read error logs and researched with that words. Through this experience, I got confidence reading error messages.
最初の課題は、製品を作るための環境作りでした。プロジェクトを最小化したいので、VSCodeでデバッグするための環境を整える必要がありました。
2つ目の課題は、インストールしたライブラリがターミナルで見つからない原因を探ることでした。いくつかの異なるバージョンのPythonをインストールした場合、VSCodeとターミナルで異なるPythonが使われていることが原因だとわかりました。
3つ目の課題は、Pythonでclickイベントを実装する方法を見つけることでした。より良いユーザー体験のために重要だと思ったので、本に投票するためのボタンを実装する方法の研究に時間を費やしました。そして、jQueryとajaxを使うことにしました。
このような問題を解決するために、私はエラーログを読み、その言葉を使って研究しました。このような経験を通して、エラーメッセージを読むことに自信を持つことができました。
。
#### Futre features
---
- Users can leave comments for each book
- Users can create own icon with uploading picture
- Uploading book image
#### Reference
- [Pipenv: Python Dev Workflow for Humans](https://pipenv-fork.readthedocs.io/en/latest/index.html#pipenv-python-dev-workflow-for-humans)