Skip to content

Commit 7699644

Browse files
Update README.md
1 parent d1eaab3 commit 7699644

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,25 @@
99
* MongoDB
1010
* Postman
1111

12-
# Task List Status
12+
## Task List Status
1313
- [X] Rest controllers and models using SpringBoot
1414
- [X] MongoDB configuration
1515
- [X] TravisCI build
1616
- [X] SonarQube integration
1717
- [ ] 80% and above Code Coverage
1818
- [ ] Cloud deployment script addition to travis
1919

20+
## ```Setup Steps ```
2021

21-
# Step 1: Creating a Database
22+
### Step 1: Creating a Database
2223
Get a running instance of MongoDB that you can connect to.
2324
For more information on getting started with MongoDB, visit their [online tutorial](https://docs.mongodb.com/manual/).
2425

2526
Start by creating a test database. I will call mine "rest_tutorial" using the following command in the MongoDB shell, or through a database manager like MongoDB Compass:
2627
```use rest_tutorial;```
2728
This will create a new database in MongoDB that we can use for our tutorial.
2829

29-
# Step 2: Adding a MongoDB Collection and Data
30+
### Step 2: Adding a MongoDB Collection and Data
3031
Create a sample collection that will hold data about different types of pets. Let's create the collection with the following command:
3132

3233
```db.createCollection("pets");```
@@ -51,11 +52,11 @@ We can add data to the collection with the following command:
5152
```}```
5253
```]);```
5354

54-
# Step 3: Adding mongodb credentials
55+
### Step 3: Adding mongodb credentials
5556
Add the mongodb authentication-database, username & password in [application.properties](https://github.com/GouravRusiya30/SpringBootRestAPI/blob/master/src/main/resources/application.properties)
5657
If there is no authrntication when you are running locally then you can also remove these properties from this file.
5758

58-
# Step 4: Testing Your API
59+
### Step 4: Testing Your API
5960
Once the server starts, you are free to test your API however you choose.
6061
For example :
6162
* POST 'http://localhost:8080/pets'

0 commit comments

Comments
 (0)