8000 GitHub - Crispy-rw/pulse
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000

Crispy-rw/pulse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API ENDPOINTS

Ressource URL Methods Description Authentication required Body
/api/adduser POST Create user account No (name)
/api/addsubscription POST Add Subscription No (userId,subs_plan_type, start_date, end_date, source_type, source )
/api/editsubscription/subId PUT Edit Subscription No
/api/allsubscription GET get All Subscription No
/api/notify POST send Notification No

Features

  • Create an account
  • Create Subscription
  • Edit Subscription
  • Send Notification
  • Get All Notification

Language

 Javascript

Server Environment

 NodeJS (run time Environment for running JS codes)

Framework

 Express

Getting started

These instructions will get you a copy of this project up and running on your local machine for development and testing purposes.

Prerequisites

I assume you already have NodeJS, npm and mysql installed. To install this project on your local machine, you need first to Unzip the project and set up the env variable file by filling in the required environment variables (Refer to the env.example file)

Install

npm install

Usage

This project built on top of expressJS and postgreSQL as database and then import database. So, to make things easy, you need to setup your env variable properly by by refering to the .env.example file and then runnpm start to migrate and start the server accordingly or if you want to run in development mode you can just run the following commands and lasty import this file c796debe-9542-499a-998d-d6e09b3a9883.json to https://hoppscotch.io/

npm run dev

Author

👤 Nshimyumukiza Christian

License & copyright

ISC License (ISC)

Copyright (c) 2021 Nshimyumukiza Christian

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0