Giter Club home page Giter Club logo

node-restful-api's Introduction

summitech-node-developer-test

This is an assessment I did for the role of a NodeJS backend developer at Summitech

Software Engineer Assessment

This application is built with the following technologies:

  1. NodeJS(v16.13.2)
  2. MYSQL(5.1.0)
  3. Font-awesome(4.7.0)
  4. NPM version 8.1.2

This is how you can install this application

  1. Clone this Repository(Repo) with the following command git clone https://github.com/Bonifaceebuka/summitech-node-developer-test.git
  2. Move to the DIR of the Repo cd summitech-node-developer-test
  3. Install the necessary NPM packages with npm install
  4. Save .env.example file as .env or run this command: cp .env.example .env
  5. Open the .env file and set the Database configurations as follows:
    DB_CONNECTION_DIALECT=mysql
    DB_HOST=127.0.0.1
    DB_PORT=3306
    APP_KEY=ANY_RANDOM_VALUE
    DB_DATABASE=YOUR_DATABASE_NAME
    DB_USERNAME=YOUR_SERVER_USERNAME
    DB_PASSWORD=YOUR_DATABASE_PASSWORD (Leave it empty if you have none)
    PORT=YOUR_PREFERRED_PORT_NUMBER
  6. Import the database tables using summitech_inventory_db.sql file in 'db' folder of this project
  7. Start your server with npm run dev

About the API documentation

The complete API documentation for this project is published on Postman. You can access it using this link https://documenter.getpostman.com/view/16611684/2s935kNkPr

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.