Skip to content

Commit 7e3e491

Browse files
brooke-krjb75
authored andcommitted
fix: typos in README's
1 parent 7e47b90 commit 7e3e491

File tree

3 files changed

+17
-8
lines changed

3 files changed

+17
-8
lines changed

Docker/README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,11 @@ To run an individual container for a microservice ensure that the the `.env` fil
3434
$ docker run -d -p <app port>:<local port> <container tag>
3535
```
3636

37-
*Note:* this will run your container in detached mode (i.e. in the background). Omitting the `-d` flag in the above command will show the output of the container in your current terminal.
37+
*Note:* this will run your container in detached mode (i.e. in the background). Omitting the `-d` flag in the above command will show the output of the container in your current terminal.
38+
39+
## Running Test Cases
40+
To run all of the test cases with the exception of Maven Test cases run the following:
41+
42+
```bash
43+
$ docker-compose -f Docker/docker-compose-test.yml
44+
```

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ All source code for the project will be contained within this GitHub repository.
126126

127127
Our git tree requires linear history, so all pull requests should be rebased if there are any conflicts.
128128

129-
## Naming conventions for commits and pull requests should follow the [Convectional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standards.
129+
## Naming conventions for commits and pull requests should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standards.
130130

131131
### **License**
132132

UserGuide.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
# Official *Xplore* User Guide
1+
# Official *Xplored* User Guide
22

33

44

55
## Getting Started
66

7-
To use *Xplore*, you will need to be logged in with a valid account. If you don't have a valid account or you have not logged in prior to accessing *Xplore*, you will be redirected to the the login page and asked to enter your username and password.
7+
To use *Xplored* you will need to be logged in with a valid account. If you don't have a valid account or you have not logged in prior to accessing *Xplored* you will be redirected to the the login page and asked to enter your username and password.
88

9-
> **Tip!** Ensure your brower is set to accept cookies so you remain logged in throughout your session using *Xplore*
9+
> **Tip!** Ensure your brower is set to accept cookies so you remain logged in throughout your session using *Xplored*
1010
1111
### Making An Account
1212

13-
Making an account can be done at the *Sign Up page* (below).![Sign Up page](./readme-assets/signupPage.jpeg) To make an account, you'll need to put in an email that will act as your username, and create a password. Make sure both password fields match, or your account won't be created and you'll be asked to enter your information again.
13+
Making an account can be done at the *Sign Up page* (below).![Sign Up page](./readme-assets/signupPage.jpeg) To make an account, you'll need to put in an email that will act as your username, and create a password.
14+
15+
Make sure both password fields match and that your password is at least 6 characters, or your account won't be created and you'll be asked to enter your information again.
1416

1517
Once you're signed up, you'll need to navigate to the Login page. This can be done by clicking the link in the top right corner of the screen. Then, follow the instructions below for logging in.
1618

@@ -26,9 +28,9 @@ To log in, enter the email you used to sign up for your account as your username
2628

2729
## Managing Your Trips
2830

29-
To manage your trips, ensure you are on the [*Xplore homepage*](www.ADDRESSHERE.com). If you aren't, be sure to follow the [guide to getting started](#getting-started).
31+
To manage your trips, ensure you are on the [*Xplored homepage*](www.ADDRESSHERE.com). If you aren't, be sure to follow the [guide to getting started](#getting-started).
3032

31-
All trip management is done from the *Xplore* homepage (below)
33+
All trip management is done from the *Xplored* homepage (below)
3234

3335
![Home page and travel planner](./readme-assets/homePage.jpeg)
3436

0 commit comments

Comments
 (0)