Git Product home page Git Product logo

announcementsapi's Introduction

Announcements API

This is a basic API built with Laravel to feed announcements to any SPA application

Infrastructure

  • Ubuntu 22.04
  • PHP 8.1^
  • Apache 2.4
  • Mysql 5.7.^
  • NodeJS ^latest | ^14
  • Redis
  • MongoDB 3.6

Application

Local Development Environment Setup Instructions

Step 1 - Install necessary system requirements

Install the following base dependencies on your computer:

Virtualization Environment
  • Docker - latest
Backend Dependencies Setup: Apache, PHP, Mysql, Perl

NOTE: For Windows systems you may need to install XAMPP

  • PHP - See infrastructure - will be used to install php dependencies (optional)
Frontend Dependencies Setup: NodeJS

Step 2 - Start Dev. Environment

  • Navigate to project directory
  • Configure environment: cp .env.local.example .env - customize if needed
  • Install php dependencies: composer install
  • Set up application: sail up -d
  • Set application key: ./vendor/bin/sail artisan key:generate | sail artisan key:generate
  • Run database migrations: ./vendor/bin/sail migrate | sail artisan migrate
  • Seed the database: ./vendor/bin/sail artisan db:seed | sail artisan db:seed -- this will create 20 dummy announcements

announcementsapi's People

Contributors

drmaxis avatar

Watchers

 avatar

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.