yan-fung / backend-hashtag-generator

Command Shift Bootcamp Final Project - Hashtag Generator

# 📱 Hashtify - Hashtag Generator App

Introduction

This is the backend for #️Hashtify app (frontend repo here) This group project was created by Geroge and Yan as part of the Command Shift bootcamp course.

Quick Start and Commands

1. Clone the repo:

git clone gh repo clone yan-fung/backend-hashtag-generator

2. Run the development server for the app. It listens on port 4000.

npm start

3. To test the codes in tests folder

npm test

4. Download Postman and pgAdmin and use them to check if the CRUD operations is working.

• Postman
• pgAdmin
• Docker

Development Mode

The server side Express code will be served by a node server using Nodemon which helps in automatically restarting the server whenever server side code updates.

API Endpoints and Methods

Auth endpoints and methods

Methods	URLs	Actions
POST	/auth/:id	handle authentication

Hashtag endpoints and methods

Methods	URLs	Actions
GET	/hashtags	get all hashtags
GET	/hashtags/:id/hashtag	get all hashtags by user id
GET	/hashtags/:category	get all hashtags by category
GET	/hashtags/:id/:category	get specific hashtags by user id
POST	/hashtags	add hashtags
DELETE	/hashtags/:id	remove hashtag by id

APIs Used

RiteKit API

• Generate hashtags by image

• Generate hashtags by keyword

• Hashtag stats

Thank You

Thank you to my teammate - Geroge and all the tutors and everyone in our cohort at Command Shift.