mirror of
https://github.com/developersIndia/deviras.git
synced 2024-11-30 02:32:42 +05:30
📝 add setup docs
This commit is contained in:
parent
d00584d37c
commit
399f2a77f2
36
README.md
36
README.md
@ -8,20 +8,38 @@
|
|||||||
|
|
||||||
## Scripts
|
## Scripts
|
||||||
|
|
||||||
1. [main.py](https://github.com/developersIndia/deviras/blob/main/main.py)
|
### [main.py](https://github.com/developersIndia/deviras/blob/main/main.py)
|
||||||
- Used for changing the text below total members & live members count in a subreddit
|
|
||||||
|
Used for changing the text below total members & live members count in a subreddit.
|
||||||
|
|
||||||
![r/developersIndia About widget](https://user-images.githubusercontent.com/34342551/185678556-e4c911c9-fb12-49da-9ca6-8f8ce2ad9b5a.png)
|
![r/developersIndia About widget](https://user-images.githubusercontent.com/34342551/185678556-e4c911c9-fb12-49da-9ca6-8f8ce2ad9b5a.png)
|
||||||
|
|
||||||
## Tests
|
## Setup
|
||||||
|
|
||||||
To run the tests, simply run the following command in the Python virtual environment:
|
1. Clone the repo
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ python -m unittest
|
git clone https://github.com/developersIndia/deviras.git
|
||||||
```
|
```
|
||||||
|
2. Initialise a virtual environment.
|
||||||
|
|
||||||
## Resources
|
```bash
|
||||||
|
cd deviras
|
||||||
|
python3 -m venv venv
|
||||||
|
source venv/bin/activate
|
||||||
|
```
|
||||||
|
3. Install dependencies
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
4. To run the tests, use the following command in a python virtual environment:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m unittest
|
||||||
|
```
|
||||||
|
|
||||||
|
## Resources & Learning Material
|
||||||
|
|
||||||
- [PRAW Docs](https://praw.readthedocs.io/en/stable/code_overview/other/idcard.html)
|
- [PRAW Docs](https://praw.readthedocs.io/en/stable/code_overview/other/idcard.html)
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user