Skip to content

Commit 9c62907

Browse files
Updated README
1 parent ab3b293 commit 9c62907

File tree

1 file changed

+16
-21
lines changed

1 file changed

+16
-21
lines changed

README.md

+16-21
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This is an enterprise website template built using **React 18** (with **TypeScri
1515
- [Copyright and License](#copyright-and-license)
1616

1717

18-
### Prerequisites
18+
## Prerequisites
1919

2020
Install the following prerequisites:
2121

@@ -25,9 +25,9 @@ Install the following prerequisites:
2525
3. [Visual Studio Code](https://code.visualstudio.com/download)
2626

2727

28-
### Installation
28+
## Installation
2929

30-
#### Backend
30+
### Backend
3131

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

@@ -85,7 +85,7 @@ python manage.py createsuperuser
8585

8686
When prompted, enter a username, email, and password.
8787

88-
#### Frontend
88+
### Frontend
8989

9090
#### 1. Install required frontend dependencies
9191

@@ -98,35 +98,33 @@ cd frontend
9898
npm install
9999
```
100100

101-
102-
### Run the application
101+
## Run the application
103102

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

106-
#### 1. Run backend
105+
### 1. Run backend
107106

108107
From the **backend** directory, run:
109108

110109
```bash
111110
python manage.py runserver
112111
```
113112

114-
#### 2. Run frontend
113+
### 2. Run frontend
115114

116115
From the **frontend** directory, run:
117116

118117
```bash
119118
npm start
120119
```
121120

122-
#### 3. View the application
121+
## View the application
123122

124123
Go to http://localhost:3000/ to view the application.
125124

125+
## Run the tests
126126

127-
### Run the tests
128-
129-
#### 1. Run the backend tests
127+
### 1. Run the backend tests
130128

131129
From the **backend** directory, run:
132130

@@ -135,27 +133,25 @@ python manage.py test --pattern="tests.py"
135133

136134
```
137135

138-
#### 2. Run the frontend tests
136+
### 2. Run the frontend tests
139137

140138
From the **frontend** directory, run:
141139

142140
```bash
143141
npm run test
144142
```
145143

146-
147-
### Add data to the application
144+
## Add data to the application
148145

149146
Add data through Django Admin.
150147

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

153-
154-
### Customize the application
150+
## Customize the application
155151

156152
This section describes how to customize the application.
157153

158-
#### Changing Section Titles and Subtitles
154+
### Changing Section Titles and Subtitles
159155

160156
#### 1. Products
161157

@@ -177,7 +173,7 @@ To modify the title and subtitle of the **About** section, make changes in the `
177173

178174
To modify the title and subtitle of the **Contact** section, make changes in the ```frontend/src/components/Contact.tsx``` file.
179175

180-
#### Changing Colors
176+
### Changing Colors
181177

182178
To modify the colors in the application, make changes in the ```frontend/src/theme/theme.ts``` file.
183179

@@ -193,7 +189,6 @@ To modify the logo in the application, make changes in the ```frontend/src/layou
193189

194190
To modify the two buttons in the Hero section, make changes in the ```frontend/src/components/HeroButtons.tsx``` file.
195191

196-
197-
### Copyright and License
192+
## Copyright and License
198193

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

0 commit comments

Comments
 (0)