YuSetiawan/foodRecipe-server

Mama Recipe

Explore the docs »
Api Demo

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Installation
  • Documentation
  • Related Project
• Contributors
  • Meet The Team Members

About The Project

Mama Recipe is a culinary platform that allows users to explore and share their favorite food recipes. Users can sign up as food enthusiasts and/or recipe creators. The platform offers a range of features tailored to both groups. This web application is built using ReactJS, ExpressJS, and PostgreSQL.

Built With

These are the libraries and service used for building this backend API

• Node.js
• Express
• PostgreSQL
• Json Web Token
• Multer

Installation

1. Clone this repository

git clone https://github.com/YuSetiawan/foodRecipe-server

2. Change directory to markisak-be

cd foodRecipe-server

3. Install all of the required modules

npm install

4. Create PostgreSQL database, query are provided in query.sql

5. Create and configure .env file in the root directory, example credentials are provided in .env.example

- Please note that this server requires Google Drive API credentials and Gmail service account
- Otherwise API endpoint with image upload and account register won't work properly

6. Run this command to run the server

npm run server

• Or run this command for running in development environment

npm run dev

• Run this command for debugging and finding errors

npm run lint

Documentation

Documentation files are provided in the docs folder

• Postman API colletion
• PostgreSQL database query

API endpoint list are also available as published postman documentation

Related Project

🚀 Backend Food Recipe Mobile App

🚀 API Demo

Project link : Food Recipe Server