Skip to content

Commit

Permalink
Added "Setting up the project manually" instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Gochim committed Oct 16, 2019
1 parent ad8528c commit 66e9944
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,38 @@
# Contribution

## Requirements

- Python 3.6
- Git CLI installed
- Python, pip and git are available as commands (add to path if needed)

## Setting up the project manually

## Setting up the project with PyCharm/IntelliJ
Virtual environment will be created in *PyfaEnv* folder. Project will be cloned and run from the *PyfaDEV* folder. Separate virtual environment will be created so required libraries won't clutter the main python installation.

Clone the repo
`git clone <repo> PyfaDEV`

Create virtual environment
`python -m venv PyfaEnv`

Activate virtual environment

```
For cmd.exe: PyfaEnv\scripts\activate.bat
For bash: source <venv>/bin/activate
```
> For other OSes check [Python documentation](https://docs.python.org/3/library/venv.html)
Install requirements for the project from *requirements.txt*
`pip install -r PyfaDEV\requirements.txt`

Check that libs from *requirements.txt* are installed
`pip list`

Test that the project is starting properly
`python PyfaDEV\pyfa.py`



## Setting up the project with PyCharm/IntelliJ

0 comments on commit 66e9944

Please sign in to comment.