Description

🐘 PostgreSQL Backend server for Soupify recipes webapp. Written with Node.js + express using Azure cloud 🌀 This project is created for learning purposes of code quality, testing and architecture design. This RESTful API deployed with the help of Heroku which allowing CD.
Live API Server: https://soupify.herokuapp.com/api.

---

Linked Repositories

• Front-end Web client
• API Specification v1.2

---

📃 Documentation

• OpenApi 3 Specification - files in API folder
• Vue.js Web Application
• Default Users:
  • Admin - root: toor!1

---

⚠️ Prerequisites

You need to have installed the following software:

• Node.js (>=10.0.0)
• npm (>= 6.13.0)

📦 How To Install

You can modify or contribute to this project by following the steps below:

1. Clone the repository

• Open terminal ( Ctrl + Alt + T )

• Clone to a location on your machine.

  # Clone the repository
  $> git clone https://github.com/serfati/soupify.git
  
  # Navigate to the directory
  $> cd soupify

2. Setup

• Install npm packages in project directory

  $> npm install

• Create a copy of .env.example file to .env
  

  $> cp .env.example .env

• Set up your environment in the new /.env file

  You can change the selected environment

  app_name=soupify
  node_port=5000
  database_name=
  database_host=
  database_user=
  database_port=
  database_password=
  secretOrKeyJwt=
  files_path=
  spooncaular=
  cloudinary_name=
  cloudinary_key=
  cloudinary_secret=
  bcrypt_rounds=10

3. Run Locally

# run server
$> npm start

# open your browser at port 5000
$> google-chrome http://localhost:5000/

• Or just click here: http://localhost:5000/

Dependencies and Main Packages

• express.js - web application framework
• passport - JWT authorization
• axios - HTTP requests
• PostgreSQL - Azure server
• other dependencies you can see in package.json

📜 Scripts:

• start - Run whole application
• dev - Run application in development mode
• test - Run all tests

---

⚖️ License

• MIT license
• Copyright 2020 © serfati.

⬆ back to top