Skip to content

Commit c74f6d7

Browse files
committed
updated readme file
1 parent 39c409b commit c74f6d7

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ The ultimate goal of a task management application is to empower users to manage
1515
- Language: Python 3.11.3
1616
- Framework: Django 4.0+
1717
- Database: Dbsqlite3
18+
- Methodology: Test Driven Development
1819

1920
# Objectives
2021

@@ -62,21 +63,28 @@ Implement data backup and synchronization features to prevent data loss and ensu
6263
# Getting Started
6364
To run the API locally, follow these steps:
6465

65-
1. Clone the repository: `git clone https://github.com/devsylva/TaskFlow-API.git`
66+
1. Clone the repository:
67+
```git clone https://github.com/devsylva/TaskFlow-API.git```
6668

67-
2. Create a virtual environment inside the project directory: `python -m venv venv`
69+
2. Create a virtual environment inside the project directory:
70+
```python -m venv venv```
6871

69-
3. Activate the virtual environment: `source venv/bin/activate`
72+
3. Activate the virtual environment:
73+
```source venv/bin/activate```
7074

71-
4. Install dependecies: `pip install -r requirements.txt`
75+
4. Install dependecies:
76+
```pip install -r requirements.txt```
7277

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

75-
6. Setup the database: `python manage.py migrate`
80+
6. Setup the database:
81+
```python manage.py migrate```
7682

77-
7. Create a superuser account: `python manage.py createsuperuser`
83+
7. Create a superuser account:
84+
```python manage.py createsuperuser```
7885

79-
8. Start the development server: `python manage.py runserver`
86+
8. Start the development server:
87+
```python manage.py runserver```
8088

8189

8290
# Running Tests

0 commit comments

Comments
 (0)