Skip to content

Commit 98b6ed2

Browse files
committed
updated readme file again...
1 parent 9752f72 commit 98b6ed2

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,33 +65,47 @@ To run the API locally, follow these steps:
6565

6666
1. Clone the repository:
6767

68-
```git clone https://github.com/devsylva/TaskFlow-API.git```
68+
```
69+
git clone https://github.com/devsylva/TaskFlow-API.git
70+
```
6971

7072
2. Create a virtual environment inside the project directory:
7173

72-
```python -m venv venv```
74+
```
75+
python -m venv venv
76+
```
7377

7478
3. Activate the virtual environment:
7579

76-
```source venv/bin/activate```
80+
```
81+
source venv/bin/activate
82+
```
7783

7884
4. Install dependecies:
7985

80-
```pip install -r requirements.txt```
86+
```
87+
pip install -r requirements.txt
88+
```
8189

8290
5. Change `.env.templates` in the src/taskflow direct to `.env` and setup your environment variables
8391

8492
6. Setup the database:
8593

86-
```python manage.py migrate```
94+
```
95+
python manage.py migrate
96+
```
8797

8898
7. Create a superuser account:
8999

90-
```python manage.py createsuperuser```
100+
```
101+
python manage.py createsuperuser
102+
```
91103

92104
8. Start the development server:
93105

94-
```python manage.py runserver```
106+
```
107+
python manage.py runserver
108+
```
95109

96110

97111
# Running Tests
@@ -103,7 +117,7 @@ Tests are organized into different files within the app's tests directory. Here'
103117
python manage.py test
104118
```
105119

106-
2. To run a single test file, use the following command [replacing `<app_nam>` and `<test_file>` with the appropriate values]:
120+
2. To run a single test file, use the following command [replacing `<app_name>` and `<test_file>` with the appropriate values]:
107121

108122
```
109123
python manage.py test <app_name>.tests.<test_file>

0 commit comments

Comments
 (0)