Skip to content

Commit 99c34b7

Browse files
committed
modified: README.md
1 parent ff6a484 commit 99c34b7

File tree

1 file changed

+23
-25
lines changed

1 file changed

+23
-25
lines changed

README.md

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -58,48 +58,47 @@
5858
## Prerequisites
5959
* Clone
6060
* Clone repo through CLI
61-
```bash
62-
$ git clone https://github.com/LabConnect-RCOS/LabConnect-Backend.git
63-
```
61+
```bash
62+
$ git clone https://github.com/LabConnect-RCOS/LabConnect-Backend.git
63+
```
6464
* or through [Github Desktop](https://desktop.github.com/)
6565
* Install Python 3.12.4
6666
* Windows: [here](https://www.python.org/downloads/release/python-3124/)
6767
* Linux:
68-
```
69-
$ sudo apt install python3
70-
```
68+
```
69+
$ sudo apt install python3
70+
```
7171
* Install PostgreSQL
7272
* Windows: [here](https://www.enterprisedb.com/downloads/postgres-postgresql-downloads)
7373
* Linux:
74-
```
75-
$ sudo apt install postgresql
76-
```
74+
```
75+
$ sudo apt install postgresql
76+
```
7777
* Install Libraries
7878
```
7979
$ python3 -m pip install -r requirements.txt
8080
```
8181
* Setup user and initialize database
8282
* Windows:
83-
```
84-
$ psql -U postgres -d postgres - Windows
85-
$ CREATE DATABASE labconnect;
86-
$ ALTER USER postgres WITH PASSWORD 'root';
87-
$ \q
88-
```
83+
```
84+
$ psql -U postgres -d postgres - Windows
85+
$ CREATE DATABASE labconnect;
86+
$ ALTER USER postgres WITH PASSWORD 'root';
87+
$ \q
88+
```
8989
* Linux:
90-
```
91-
$ sudo -i -u postgres
92-
$ psql
93-
$ ALTER USER postgres WITH PASSWORD 'root';
94-
$ \q
95-
$ exit
96-
$ sudo -u postgres createdb labconnect
97-
```
90+
```
91+
$ sudo -i -u postgres
92+
$ psql
93+
$ ALTER USER postgres WITH PASSWORD 'root';
94+
$ \q
95+
$ exit
96+
$ sudo -u postgres createdb labconnect
97+
```
9898
9999
## Testing
100100
* Run pytest
101101
* Run all the test files and generate a coverage report. Coverage reports are set up to output to the terminal and provide an HTML file that can be viewed to show what branches or statements are not covered. It is in the project's best interest to have high coverage to ensure all statements and branches work as expected.
102-
103102
```bash
104103
$ make test
105104
```
@@ -115,7 +114,6 @@
115114
## Development
116115
* Run flask with python directly
117116
* Run all the test files
118-
119117
```bash
120118
$ make develop
121119
```

0 commit comments

Comments
 (0)