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.

Sign up for GitHub

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

Update Document: git and local env #244

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Update Document: git and local env #244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3389fb
Update git and local env
cocodrips Jan 17, 2025
6dd8560
Update link: Pathを通す
cocodrips Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions document/01-git.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ In this step, we will learn how to use Git and GitHub.

* (JA)[Gitを使ったバージョン管理](https://backlog.com/ja/git-tutorial/intro/01/)
* (JA)[Udemy Business - Git：はじめてのGitとGitHub](https://mercari.udemy.com/course/intro_git/)

* (EN)[Git basics](https://www.atlassian.com/git)
* (EN)[Udemy Business - GitHub Ultimate: Master Git and GitHub - Beginner to Expert](https://mercari.udemy.com/course/github-ultimate/)



## Fork this **mercari-build-training** repository

* Fork [mercari-build-training](https://github.com/mercari-build/mercari-build-training)
Expand All @@ -29,6 +27,8 @@ In this step, we will learn how to use Git and GitHub.

2. Set your name and email address using git config. Check if your email address shows up.
```shell
$ git config --global user.name "<your name>"
$ git config --global user.email "<your-email-address>"
Comment on lines +30 to +31
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

書いていないと去年みんなここで引っかかったので

$ git config user.email
<your-email-address>
```
Expand Down
6 changes: 4 additions & 2 deletions document/01-git.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

* (JA)[Gitを使ったバージョン管理](https://backlog.com/ja/git-tutorial/intro/01/)
* (JA)[Udemy Business - Git：はじめてのGitとGitHub](https://mercari.udemy.com/course/intro_git/)

* (EN)[Git basics](https://www.atlassian.com/git)
* (EN)[Udemy Business - GitHub Ultimate: Master Git and GitHub - Beginner to Expert](https://mercari.udemy.com/course/github-ultimate/)

## **mercari-build-training** リポジトリをフォークする

* [mercari-build-training](https://github.com/mercari-build/mercari-build-training)
Expand All @@ -25,8 +25,10 @@
* Macを使っている場合: [brew](https://brew.sh/index_ja) をインストールしてから `brew install git`を実行
* For Windows user: Download [installer](https://gitforwindows.org/)

2. git configに自分の名前とemailアドレスを設定します。以下のコマンドを実行してあなたのemailアドレスが表示されればOKです。
2. git configに自分の名前とemailアドレスを設定します。以下のコマンドを実行して最後にあなたのemailアドレスが表示されればOKです。
```shell
$ git config --global user.name "<your name>"
$ git config --global user.email "<your-email-address>"
$ git config user.email
<your-email-address>
```
Expand Down
17 changes: 10 additions & 7 deletions document/02-local-env.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,16 @@ Choose either Python or Go and build your local environment.
## Building Python environment

### 1. Install Python
* If your local version is below Python3.8, install Python3.10.
* If you have Python3.8 or above, you can skip the installation step.
* If your local version is below Python3.9, install Python3.13.
* If you have Python3.9 or above, you can skip the installation step.

### 2. Check your Python version

* Check if the Python is added to your PATH (usable as commands on your terminal) with the following command.

```shell
$ python -V
$ python3 -V
# Or $ python -V
Comment on lines +17 to +18
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Macのデフォルトがpythonからpython3になった

```

If the version does not correspond to the Python version you installed, double check your installation as it is not **added to your PATH**.
Expand All @@ -32,17 +33,19 @@ You can install the dependencies by running the following command.
$ cd python

# Create virtual environment for this application
$ python -m venv .venv
$ source .venv/bin/activate
# When you use non-UNIX os, the activation method is different.
$ python3 -m venv .venv　

# Activate virtual environment
$ source .venv/bin/activate # for Mac or Unix user
$ ./venv/Scripts/activate # for Windows user

# Install required library
$ pip install -r requirements.txt
```

If you added a library, make sure you add it to `requirements.txt`.

`python -m venv .venv` is a command to create a Python virtual environment.
`python3 -m venv .venv` is a command to create a Python virtual environment.
A virtual environment is a way to create a project-specific Python environment.
Using a virtual environment allows you to manage necessary packages separately for each project so that you can avoid dependency conflicts between different projects.
Once the virtual environment is created, it must be activated by the `source .venv/bin/activate` command.
Expand Down
22 changes: 15 additions & 7 deletions document/02-local-env.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,43 @@ PythonかGoから1つの言語を選び、環境を作りましょう。
## Pythonの環境を作る

### 1. Pythonをインストールする
* Python3.8以上がインストールされていない場合、Python3.10をインストールします
* すでに3.8以上がインストール済みの方はskipして問題ないです
* Python3.9以上がインストールされていない場合、Python3.13をインストールします
* すでに3.9以上がインストール済みの方はskipして問題ないです

### 2. Pythonのバージョンをチェックする

* インストールしたPythonにパスが通っている(=ターミナルから使える状態)か確認します。

```shell
$ python -V
$ python3 -V
# もしくは $ python -V
```

表示されるPythonのバージョンがインストールしたものではなければ、**パスが通っていない**状態なので確認してください。

**:book: Reference**

* [PATHを通すとは？- 初心者でも分かる解説](https://hara-chan.com/it/programming/environment-variable-path/)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

リンク切れしてた

* [「PATHが通っている」とはどういう状態か?](https://zenn.dev/d0ne1s/articles/1f435463551ac2)
* Windowsの方向け [【環境構築 入門】PATHの通し方 – Windows11, M1 Mac 対応 –](https://www.kikagaku.co.jp/kikagaku-blog/path/)

### 3. 依存ライブラリをインストールする

Pythonでは、`requirements.txt`というファイルに依存しているライブラリの一覧を記載します。
以下のコマンドを実行することで、依存ライブラリをまとめてインストールすることができます。

### Unix or Mac
```shell
$ cd python

# 仮想環境をつくる
$ python -m venv .venv
$ source .venv/bin/activate
# Unixを利用していない場合コマンドが違うことがあります
$ python3 -m venv .venv

# 仮想環境をアクティベートする
$ source .venv/bin/activate # Unix / Macの場合
$ ./venv/Scripts/activate # windowsの場合

# 今回使うPythonのパスを確認する。
$ which python

# 必要なライブラリをインストールする
$ pip install -r requirements.txt
Expand Down
Loading