Giter VIP home page Giter VIP logo

inisev-subscription's Introduction

Inisev Subscription API

Prerequisites

  • Php ^8.0.2
  • MySQL ^5.7
  • Composer

Installation

  1. Clone the repository
  2. Run composer install
  3. Copy env.example.env to .env
  4. Run php artisan key:generate
  5. Run php artisan migrate
  6. Run php artisan db:seed
  7. Configure your mail client in .env file
  8. Run php artisan serve to fire up your application.
  9. Open your API client and go to http://localhost:8000/ to test your API.

Api Endpoints

  • api/v1/user/create: POST - Create a new User (Requires name, email)
  • api/v1/website/create: POST - Create a new Website (Requires name, url)
  • api/v1/user/{user}/website/subscribe: POST - User subscribes to a website (Requires website_id)
  • api/v1/website/{website}/post/create: POST - Create a new post for a website (Requires title, description)

Note: Whenever a new post is published on a particular website, all the users who subscribed to that website will receive an email notification after running php artisan posts:notify which will push email jobs onto the queue , then php artisan queue:work command to start the Queue worker.

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.