Skip to content

Commit 7f9665c

Browse files
committed
readme is updated
1 parent e1582d7 commit 7f9665c

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

docs/README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,7 @@ Additionally, a `db.json` file must be provided for the backend, containing samp
9797

9898
To emulate a database, **sparrest.js** will be used — a REST API created by instructor Alberto Casero (KeepCoding), based on `json-server`.
9999

100-
### Cloning the Repository
101100

102-
```bash
103-
git clone https://github.com/kasappeal/sparrest.js.git
104-
```
105-
106-
This will start the server and run the REST API, allowing interaction with the simulated database.
107101

108102
## Technologies Used
109103

@@ -123,13 +117,21 @@ This will start the server and run the REST API, allowing interaction with the s
123117
- **Visual Studio Code**: Integrated Development Environment (IDE) required to run the project. Make sure to use version 1.99.0 to avoid compatibility issues.
124118
- **Live Server**: A Visual Studio Code extension that allows you to preview HTML files locally in a browser, showing real-time changes.
125119

126-
### Steps to Use This Project
120+
### Cloning the Repository
127121

128-
1. Download the compressed project file from GitHub to your computer or clone it using SourceTree.
122+
```bash
123+
git clone https://github.com/kasappeal/sparrest.js.git
124+
```
125+
126+
```bash
127+
git clone https://github.com/kasappeal/sparrest.js.git
128+
```
129+
130+
![Demo](https://github.com/PabloSch26/pablo-abaroa-schilling/blob/main/etc/clone-repository-visual-studio-code.gif)
129131

130-
2. Once downloaded or cloned, add it to your workspace in Visual Studio Code.
132+
This will start the server and run the REST API, allowing interaction with the simulated database.
131133

132-
3. After downloading Sparrest, update its dependencies. Then, to incorporate the sample database used in this project, copy the project's `db.json` file and replace the one generated by Sparrest when initialized.
134+
After downloading Sparrest, update its dependencies. Then, to incorporate the sample database used in this project, copy the project's `db.json` file and replace the one generated by Sparrest when initialized.
133135

134136
To start the database, simply run the following command inside the Sparrest directory:
135137

@@ -140,10 +142,9 @@ npm start
140142
### Notes
141143

142144
- The `db.json` file contains three accounts and 14 posts. These are the credentials for logging in and editing the existing posts:
143-
144-
- [pablsch.it@gmail.com](mailto:pablsch.it@gmail.com) / pwd: 123456
145-
- [Pedro.it@gmail.com](mailto:Pedro.it@gmail.com) / pwd: 123456
146-
- [jose.JJ@gmail.com](mailto:jose.JJ@gmail.com) / pwd: 123456
145+
- [pablsch.it@gmail.com](mailto:pablsch.it@gmail.com) / pwd: 123456
146+
- [Pedro.it@gmail.com](mailto:Pedro.it@gmail.com) / pwd: 123456
147+
- [jose.JJ@gmail.com](mailto:jose.JJ@gmail.com) / pwd: 123456
147148

148149
## No Contributions or License
149150

0 commit comments

Comments
 (0)