Skip to content

Commit 47a94af

Browse files
Updated README
1 parent 2a52b82 commit 47a94af

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This is a portfolio website built using **Django 4**, **Django REST Framework 3*
1414
- [Customizing the application](#customize-the-application)
1515
- [Copyright and License](#copyright-and-license)
1616

17-
### Prerequisites
17+
## Prerequisites
1818

1919
Install the following prerequisites:
2020

@@ -24,9 +24,9 @@ Install the following prerequisites:
2424
3. [PostgreSQL](https://www.postgresql.org/download/)
2525
4. [Visual Studio Code](https://code.visualstudio.com/download)
2626

27-
### Installation
27+
## Installation
2828

29-
#### Backend
29+
### Backend
3030

3131
#### 1. Create a virtual environment
3232

@@ -140,7 +140,7 @@ python manage.py createsuperuser
140140

141141
When prompted, enter a username, email, and password.
142142

143-
#### Frontend
143+
### Frontend
144144

145145
#### 1. Install required frontend dependencies
146146

@@ -171,59 +171,59 @@ BACKEND_HOST=127.0.0.1
171171
BACKEND_URL=http://127.0.0.1:8000
172172
```
173173

174-
### Run the application
174+
## Run the application
175175

176176
To run the application, you need to have both the backend and the frontend up and running.
177177

178-
#### 1. Run backend
178+
### 1. Run backend
179179

180180
From the **backend** directory, run:
181181

182182
```bash
183183
python manage.py runserver
184184
```
185185

186-
#### 2. Run frontend
186+
### 2. Run frontend
187187

188188
From the **frontend** directory, run:
189189

190190
```bash
191191
npm run dev
192192
```
193193

194-
#### 3. View the application
194+
## View the application
195195

196196
Go to http://localhost:3000/ to view the application.
197197

198-
### Run the tests
198+
## Run the tests
199199

200-
#### 1. Run the backend tests
200+
### 1. Run the backend tests
201201

202202
From the **backend** directory, run:
203203

204204
```bash
205205
python manage.py test --pattern="tests.py"
206206
```
207207

208-
#### 2. Run the frontend tests
208+
### 2. Run the frontend tests
209209

210210
From the **frontend** directory, run:
211211

212212
```bash
213213
npm run test
214214
```
215215

216-
### Add data to the application
216+
## Add data to the application
217217

218218
Add data through Django Admin.
219219

220220
Go to http://127.0.0.1:8000/admin to access the Django Admin interface and sign in using the admin credentials.
221221

222-
### Customize the application
222+
## Customize the application
223223

224224
This section describes how to customize the application.
225225

226-
#### Changing Section Titles and Subtitles
226+
### Changing Section Titles and Subtitles
227227

228228
#### 1. About
229229

@@ -245,22 +245,22 @@ To modify the title and subtitle of the **Testimonials** section, make changes i
245245

246246
To modify the title and subtitle of the **Contact** section, make changes in the `frontend/src/components/Contact.js` file.
247247

248-
#### Changing Colors
248+
### Changing Colors
249249

250250
To modify the colors in the application, make changes in the `frontend/src/theme/theme.js` file.
251251

252-
#### Changing Fonts
252+
### Changing Fonts
253253

254254
To modify the fonts in the application, first, add a new font to the `frontend/src/pages/_document.js` file, and then make changes in the `frontend/src/theme/typography.js` file.
255255

256-
#### Changing Logo
256+
### Changing Logo
257257

258258
To modify the logo in the application, make changes in the `frontend/src/layout/Header.js` and `frontend/src/layout/Sidebar.js` files.
259259

260-
#### Changing Buttons in the Hero Section
260+
### Changing Buttons in the Hero Section
261261

262262
To modify the two buttons in the Hero section, make changes in the `frontend/src/components/HeroButtons.js` file.
263263

264-
### Copyright and License
264+
## Copyright and License
265265

266266
Copyright © 2022 Bob's Programming Academy. Code released under the MIT license.

0 commit comments

Comments
 (0)