Skip to content

Latest commit

 

History

History
88 lines (69 loc) · 1.84 KB

README.md

File metadata and controls

88 lines (69 loc) · 1.84 KB
Raw

Feeder

A nodejs backend API for managing user feeds!

Table of contents

General info

This API will handle the registration and login of users and send image feeds to a google cloud storage

Technologies

  • Typescript
  • Firebase
  • Google Cloud Storage

Setup

 npm i # install nodejs dependancies

 npm run dev # To start the server in developer mode

 npm run build # To build the app

 npm start # To start the built server

Test

curl -X GET
https://feedme12.herokuapp.com/api/test

Features

List of features ready and TODOs for future development

  • Enables one to register to the app
curl -X POST \
 https://feedme12.herokuapp.com/api/user/create \
 -H 'cache-control: no-cache' \
 -H 'content-type: application/json' \
 -d '{
"firstName": "feeder",
"lastName": "2.0",
"email": "feeder@mail.com",
"password": "'\''wYtH65;LBz{=3GW"
}
'
  • Enables one to login to the app
curl -X POST \
 https://feedme12.herokuapp.com/api/user/login \
 -H 'cache-control: no-cache' \
 -H 'content-type: application/json' \
 -d '{
"email": "feeder@mail.com",
"password": "'\''wYtH65;LBz{=3GW"
}
'
  • Enables an authenticated to add feed to the database and storage
# url is https://feedme12.herokuapp.com/api/feeds/create
# same goes here except we add a barier token we get from the login and add a file mapped as image and a caption mapped as caption
  • Enables an authenticated to access the feeds stored in the database
# url is https://feedme12.herokuapp.com/api/feeds/my
# here we just add the token to get all the feeds

To-do list:

  • tsc configuration
  • some error handling
  • Add some testing

Contact

Contact me using email silco2dev@gmail.com