joaomcsferreira/api_pinterest

About

Pinterest Clone backend in Express Typescript. You can access it by following this API Pinterest.

Contents

• Global requisites
• Getting started
• Installation and configuration
• List of routes
• Author

Global requisites

• node
• tsc
• mongodb

Getting started

Below mentioned are the steps to install, configure and run this app.

Installation and configuration

# clone the project.
https://github.com/Joao-MCF/api_pinterest.git

# enter the cloned directory.
cd api_pinterest

# You need have MongoDB running in the background and you have created the database.
npm install

# You need edit you archive .env using any editor.
# You Should add all the configurations details or else default values will be used.
vim .env

# compile the app and run.
npm run compile
npm start

List of routes

User routes

POST /user

POST /user/token

GET /user/:username

GET /validate

PUT /user

PUT /follow

PUT /unfollow

DELETE /user/:id

Pin routes

POST /pin

GET /pin/:id

GET /pins?type=type&board=board&user=user

PUT /pin/:id

DELETE /pin/:id

Board routes

POST /board

GET /boards/:username

DELETE /board/:id

Comment routes

POST /pin/

GET /pin/:id/comments

DELETE /pin/:id/comment/:commentId

Author

João Marcos C. Ferreira - Code and Documentation Linkedin