Light

microapidev / notification-microapi Goto Github PK

View Code? Open in Web Editor NEW

3.0 5.0 9.0 1.27 MB

A micro-service for sending notifications to subscribed users

Home Page: http://notification.microapi.dev/

PHP 94.67% HTML 3.90% Dockerfile 0.78% TSQL 0.34% Shell 0.31%

notification-microapi's Introduction

Notification Micro API

Installation Guide

Install Composer & Laravel

Fork The Repo And Clone Your Fork

cd notification-microapi

git remote add upstream https://github.com/microapidev/notification-microapi.git

git pull upstream develop

copy `.env.example` to `.env`

composer install

php artisan serve

Visit localhost:8000 in your browser

When You Make Changes

git add .

git commit _m "your message"

git pull upstream develop

Make Sure there is no conflict

git push origin develop

Then Create Your Pull Request

Add description of what you did in your pull request

Testing & Usage

Go to the docs - https://documenter.getpostman.com/view/11899454/T17DgUHn?version=latest

notification-microapi's People

Contributors

Stargazers

Watchers

Forkers

eni4sure samuelshorun sosualfred botus14 tmakinde bytedeveloperr ifatoki reichx sandygudie

notification-microapi's Issues

Endpoint - notification/update/:notification_unique_id

To update notification with details

Endpoint Notification file (editable )

A readily notification file (editable format) is missing.

Endpoint - user/retrieve/:email/:recovery_password

allow users/devs that want to send notifications to register.

Adding Laravel to the Project

Creating a skeleton API to output notifications

add routes for get a notification, delete notification and update notification.

Endpoint - subscribe/new

This endpoint is to register emails for a notification

Endpoint - notification/new

To create a new notification

Integrate Email MicroAPI for sending notifications to emails

Worked on by @eni4sure

Endpoint - unsubscribe/new

To unsubscribe a user to a notification

Endpoint - /send

To send a notification to all the subscribed users of a notification

allow people who want to receive notifications to add their details.

Endpoint - user/new

Endpoint - notification/retrieve/:email

To retrieve all notification created by an email

API Documentation

Make the API documentation

Add Basic Laravel User Authentication.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.