Code Monkey home page Code Monkey logo

documentation's Introduction

Project title here

This project was bootstrapped with Framework name here.

About this project with description

  • Point 1
  • Point 2
  • Point 3 and so on

Requirements

SDK's Used in this project

Contact Person for AWS access

  • Name: Person name
  • Email: Person email

Installation Instructions

Globally install xyz framework

npm install -g xyz
  • This installation is required due to xyz reason

Setup Instructions

Clone the repo and install the dependencies.

npm install
Create .env file in the project root
Add these credentials in .env file
DBUri=<specify value here>

Running on local

To start the server, run the following

npm start

Deployment command

npm deploy

Documentation

See the collection for documentation:

Run in Postman

Architecture Diagram

Screenshot

Flow Diagram

Screenshot

Database Design

  • This is relational database design
  • Models are defined in src/models folder Screenshot

Wiki of one complex feature

documentation's People

Contributors

ahsan-javaid avatar

Stargazers

Muneeb Meer avatar Mohsin Hayat 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.