Markisak (Recipe App)

Explore the docs »
View Demo · 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

Markisak is a food recipe website project that aims to inspire users to cook and share their favorite recipes. The name Markisak means "let's cook" in Indonesian. On this website, users can search for recipes, share their own recipes, and connect with other food enthusiasts.

One of Markisak's main features is its user-friendly search function. Users can search for recipes by food name. The website also provides detailed recipe instructions, ingredient lists, and video tutorials to assist users in the cooking process.

Another unique feature of Markisak is that users can create their own profiles, connect with other users, and share their favorite recipes. This allows users to learn from each other and explore new culinary ideas.

To use the Markisak website, users simply need to create an account and start searching or sharing recipes. The site is designed to be easy to use and accessible to all levels of culinary expertise

Built With

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

• Node.js
• Express
• PostgreSQL
• Json Web Token
• Multer
• Google Cloud Platform

Installation

Follow this steps to run the server locally :

1. Clone this repository

git clone https://github.com/ikkair/markisak-be

2. Change directory to markisak-be

cd markisak-be

3. Install all of the required modules

npm install

4. Create PostgreSQL database, query are provided in markisak-database-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
• Database diagram

API endpoint list are also available as published postman documentation

Related Project

🚀 Backend Markisak

🚀 Frontend Markisak

🚀 Demo Markisak

Contributors

This backend API is created by 3 backend team members, where each member have different tasks

@alifankebima (Alif Anke Bima Putra) :

• Relational database design
• Recipes CRUD
• Videos CRUD
• Liked Recipes CRUD
• Saved Recipes CRUD
• Comments CRUD
• Postman API documentation

@ikkair (Ikhlasul Kamal Irmansyah) :

• Team leader
• Users CRUD
• Authentication
• Email verification implementation
• Json web token implementation
• Multer implementation
• Backend deployment

@andkvnt (Andiko Oktavianto) :

• Project initialization
• Admin CRUD
• Chats CRUD
• Testing
• Recipe dummy data

Meet The Team Members

Backend Developer / Project Manager	Backend Developer	Backend Developer	Frontend Developer	Frontend Developer	Frontend Developer
Ikhlasul Kamal Irmansyah	Alif Anke Bima Putra	Andiko Oktavianto	Muhamad Ilham Darmawan	Dhimas Pandu Yogaswara	R. Rizal Yuniar S.

Project link : https://github.com/ikkair/markisak-be