docs: add running instruction

caions · Oct 4, 2023 · d186627 · d186627
1 parent f7e854c
commit d186627
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -3,14 +3,22 @@
 This is the repository for the backend of the Habit Tracker application, a Node.js API for tracking daily habits.
 This API was developed using Node.js and PostgreSQL as the database, and it follows the principles of Hexagon Architecture.
 
-## 🚀 Instalation
+## Instalation
 
 To install the project dependencies, run the following command:
 
 ```
 npm install
 ```
 
+## 🚀 Running the application
+
+```
+npm start
+```
+
+The server will run on http://localhost:8000
+
 Additionally, you need to create a PostgreSQL database named "habit-tracker" before starting the server.
 
 ## Available Routes

diff --git a/habits-document.json b/habits-document.json
@@ -1,7 +1,7 @@
 {
   "swagger": "2.0",
   "info": {
-    "version": "1.1.6",
+    "version": "1.1.7",
     "title": "Habit Tracker API",
     "description": "Api to manage habits"
   },

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "habit-tracker-backend",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "",
   "main": "index.js",
   "scripts": {