Git Product home page Git Product logo

hello-books-app's Introduction

Build Status Coverage Status

Hello Books

๐Ÿ“š A system that allows efficient, cost-effective management of our library.

Prerequisites

Kindly ensure you install the following softwares

  1. Git
  2. Node.js
  3. Node Package Manager (npm), this comes pre-installed with Node.js

Getting Started

In order to get a copy of the project up and running on your local computer for development and testing purposes. Do the following

  1. Clone the repo.
  2. Switch to project directory
  3. Create a local .env file using the .env.sample file on the root folder
  4. Type npm install to install dependencies
  5. Type npm run dev to start development server or npm start to run in production

Run Migrations

In other to run migrations, run npx knex migrate:latest OR npm run migrate

To create a new migration, run npx knex migrate:make <tablename> OR npm run make:migration <tablename>

To rollback a migration, run npx knex migrate:rollback <tablename> OR npm run migrate:rollback <tablename>

To certify that the server is operational navigate to http://localhost:5000 on your browser and you should see the message.

{ message: 'Hello Books Deferral' }

Using friendly-mail Service

To send email within the application using SMTP (mailtrap.io)

  1. Update your local .env file with the following MAIL_USERNAME=YOUR_MAILTRAP_USERNAME MAIL_PASSWORD=YOUR_MAILTRAP_PASSWORD
  2. Import Mail class from friendly-mail
  3. Create an instance of new Mail('Example')

Note: Mail is a chainable class

example: 

   const sampleMail = new Mail('Email Verification');
   sampleMail.to('[email protected]')
             .subject('some message')
             .send()  // returns a promise

hello-books-app's People

Contributors

bahdcoder avatar caleb-42 avatar dependabot[bot] avatar devpinheiro avatar fantastic-genius avatar frankchinedu avatar kevoese avatar tolumide-ng avatar vincentayorinde avatar

Watchers

 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.