Code Monkey home page Code Monkey logo

gateapp-api's Introduction

hng_logo

Gate App - API

This the Documentation for the backend api (Please Read Me)

Contains associative routes

/api/register/admin

/api/register/gateman

/api/register/resident

/api/login

/api/verify

/password/verify

/password/reset

/api/v1/user

/api/v1/user/{id}

/api/v1//user/edit

/api/v1//user/password

/api/v1//user/delete

Features

  • to be added

Installation

  • clone this repo
  • cd into the project folder
  • Run composer install to install depedencies
  • Run php artisan serve
  • visit localhost:8000 in your web browser

Rules for sending PR

  • attach a brief and concise description of what you have done
  • outline the steps to be taken in order to test the feature you added
  • attach a screenshot or gif of what you did, if possible
  • do not send PR to the master branch

Note

  • if you want to manually delete form the database this is the link

  • https://remotemysql.com/phpmyadmin/

  • use the info database username and password from .env file to login

  • the .env has been included in this commit so discard you own this time we all going to use one database which is online an a mailing of my own sendgrid

  • make sure you have internet to work

Setting up for testing

You will need PHP >= 7.2, Composer and an SQL Database to get started. MySql or PostgressSQL preferred.

  • Clone this repository
  • Run composer install to install dependencies
  • Copy .env.example to .env and edit the contents to match your environment configurations. For testing purposes, you may keep the .env file provided in the repo for uniformity
  • Run php artisan migrate to set up the DB
  • Run php artisan key:generate to generate the application key
  • For testing and development purposes, run php artisan serve. You can then access the app at http://localhost:8000 on your browser

gateapp-api's People

Contributors

junicodes avatar oluwmayowaf avatar andikangabriel avatar eyounelson avatar teevon avatar mrayor avatar j-engineers avatar afreekamode avatar veronicatee avatar dirkmal avatar pepjoe avatar ioreoluwa avatar davonjagah avatar devtitaro avatar eshy008 avatar tobbhie avatar acushlakoncept avatar codedgift avatar dollypee avatar kazeeem avatar alex-pemu avatar tobecci avatar lisaejiro avatar ayenko4all avatar bukkyolomolehin avatar hollyphat avatar emlycool avatar olanrewaju-adesanya avatar

Stargazers

 avatar

Watchers

James Cloos avatar  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.