Skip to content

Commit

Permalink
Updated the documentaion for pipenv
Browse files Browse the repository at this point in the history
  • Loading branch information
Saurav-Shrivastav committed Sep 12, 2020
1 parent f356572 commit 08ff897
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 20 deletions.
25 changes: 15 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,23 @@ We follow a systematic Git Workflow -
## Setup and running of project (Backend)

- Fork the repo and clone it.
- Go in the repo and setup virtualenvironment using <br>
`python -m virtualenv env`
- Then activate the environment using <br>
`source env/Scripts/activate` (Use only `env/Scripts/activate` if on cmd or powershell)
- For Linux Users it will be `source env/bin/activate`

- The project now uses `poetry` to manage dependencies.
- Install [Poetry](https://python-poetry.org/docs/)
- The project now uses `pipenv` to manage dependencies.
- Install [Pipenv](https://pypi.org/project/pipenv/) using the following command:
```bash
pip install pipenv
```
- Navigate to the project directory and initialize the environment using the following command -
```bash
pipenv shell --python 3.8
```
- The above step also activates the environment, for activating the environment in subsequent sessions type the following command:
```bash
pipenv shell
```
- At the root of your project directory <br>

```bash
poetry install
pipenv install
pre-commit install
```

Expand All @@ -49,6 +54,6 @@ The page will reload if you make edits.<br />

### Note

As the project now uses poetry to manage dependencies, you need to run `poetry add <package_name>` to install the new package.
As the project now uses pipenv to manage dependencies, you need to run `pipenv install <package_name>` to install the new package.

- Use only `yarn add package_name` to add new packages to the frontend part.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,23 @@ Kindly go through the entire README.md for getting familiar with contribution st
## Setup and running of project (Backend)

- Fork the repo and clone it.
- Go in the repo and setup virtualenvironment using
`python -m virtualenv env`
- Then activate the environment using
`source env/Scripts/activate` (Use only `env/Scripts/activate` if on cmd or powershell)
- For Linux Users it will be `source env/bin/activate`

- The project now uses `poetry` to manage dependencies.
- Install [Poetry](https://python-poetry.org/docs/)
- The project now uses `pipenv` to manage dependencies.
- Install [Pipenv](https://pypi.org/project/pipenv/) using the following command:
```bash
pip install pipenv
```
- Navigate to the project directory and initialize the environment using the following command -
```bash
pipenv shell --python 3.8
```
- The above step also activates the environment, for activating the environment in subsequent sessions type the following command:
```bash
pipenv shell
```
- At the root of your project directory <br>

```bash
poetry install
pipenv install
pre-commit install
```

Expand Down Expand Up @@ -98,7 +103,7 @@ We follow a systematic Git Workflow -

### Note

- As the project now uses poetry to manage dependencies, you need to run `poetry add <package_name>` to install the new package.
- As the project now uses pipenv to manage dependencies, you need to run `pipenv add <package_name>` to install the new package.
- Use only `yarn add package_name` to add new packages to the frontend part.

## Contributors ✨
Expand Down

0 comments on commit 08ff897

Please sign in to comment.