Giter VIP home page Giter VIP logo

narvan's Introduction

Narvan API

This web service is provided to calculate Ackermann function,The nth sentence of the Fibonacci sequence and Factorial function. Git Flow Feature branch is used to manage Git and Travis-ci is used for the continuous integration of the project. The Travis-ci is connected to Git's Ropositories and after every push,project starts to run on travis-ci's own servers according to configurations in .travis.yml and all its unit tests are checked automatically that you can some oof project build in image below:

travisi-ci

also,Git work flow is used to manage branches.
three part of our branch is :

  1. main
  2. develop
  3. features

Installation

to install follow the steps below:

  1. Clone repository. use this command:

git clone https://github.com/MohammadReza-Jafari/narvan.git
  1. Go to root of project

cd narvan
  1. Install venv

python -m venv virtual
  1. activate venv

  • to activate on windows machines use the following command:
.\virtual\Scripte\activate
  1. install packages

pip install -r requirements.txt

Usage

to make use of project follow the steps below:

  1. make migrations

python manage.py makemigrations
  1. migrate

python manage.py migrate
  1. create a superuser

python manage.py createsuperuser
  1. run django server

python manage.py runserver

on narvan api doc you can visit api documentation and see how to use every services. to test this api you can see narvan api doc that created by swagger and test services or go to any of following urls and make post requests with specified value and for making documentation i used swagger that tou can see below:

api doc

  • Fibonacci

    • method=post | reques-body = { “n”: An Integer value}
  • Factorial

    • method=post | reques-body = { “n”: An Integer value}
  • Ackermann

    • method=post reques-body ={“m”: An Integer value, “n”: An Integer value}

Monitoring

  1. for system monitoring you can just open log.txt in Reports directory inside project root and see details of every successful request

log.txt

  1. or by the created user in previous steps enter admin site of django and see the reports table there.

admin site

Author

Mohammad Reza Jafari

License

MIT

narvan's People

Contributors

mohammadreza-jafari 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.