README.md

Bitri Recipe Backend

Create a Node.js app for building Bitri Recipe RESTful APIs using Express.
Explore the docs »

View Web Service · Report Bug · Request Feature

Table of Contents

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Requirements
   • Installation
   • Setup .env example
3. REST API
4. Contributing
5. Related Project
6. Contact

About The Project

Create a Node.js app for building Bitri Recipe RESTful APIs using Express.

Built With

This app was built with some technologies below:

• Node JS
• Express JS
• CORS
• Bcrypt
• JSON Web Tokens
• Multer
• Cloudinary
• PostgreSQL
• and other

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Node.js

Requirements

• Node.js
• Postman for testing
• Database

Installation

• Clone the Repo

git clone -b FrontEnd+ https://github.com/pitlimitCode/Bitri_Recipe_Web.git

• Go To Folder Repo

cd Bitri_Recipe_Web

• Install Module

npm install

• Make a new database
• Setup .env
• Type npm run dev To Start Development
• Type npm run start To Start Production

(back to top)

Setup .env example

Create .env file in your root project folder.

# local postgresql
DB_HOST=
DB_NAME="YOUR_POSTGRES_NAME_SET"
DB_PORT=
DB_USER="YOUR_POSTGRES_USERNAME_SET"
DB_PASS=

# jwt
JWT_ALG=
JWT_KEY=

# cloudinary
CLOUD_NAME=
CLOUD_KEY=
CLOUD_SECRET=

(back to top)

REST API

You can view/join my Postman collection here:

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/YourNewBranchName)
3. Commit your Changes (git commit -m 'Add some YourNewBranchName')
4. Push to the Branch (git push origin feature/YourNewBranchName)
5. Open a Pull Request

(back to top)

Related Project

🚀 Repo Backend Bitri Recipe
🚀 Repo Frontend Bitri Recipe
🚀 Repo Frontend Bitri Recipe - Mobile
🚀 Web Service
🚀 Demo Bitri Recipe
🚀 Demo Bitri Recipe - Mobile

(back to top)

Contact

My Email : [email protected]

(back to top)