Git Product home page Git Product logo

war's Introduction

Write A Robot(W.A.R)

This source is the backend for Write a Robot website (Yet to build) built using nodejs.

Features

  1. REST API.
  2. HTTP Basic Auth.
  3. Mysql Database.

Dependencies

  1. Node.
  2. MySql DB. Rest of the dependencies are mentioned in package json file.

Environment setup

Set up environmental variables for the app.

DB Setup

Environment Variable Value
WAR_DB MySql DB being used
WAR_DB_HOST MySql Host
WAR_DB_USER MySql User
WAR_DB_PASS MySql Password

HTTP Auth Setup

  1. Create a file users.htpasswd in the root folder of app.
  2. Create users and associate a password to it in the following format in the users.htpasswd file.
    user_name:password

Run

  1. Make sure the mysql/maria service is started and running.
  2. Setup the Environment.
  3. Install all the dependencies. 
    npm install
  4. Run the app 
    npm start

API End-points

  1. Get project details

    GET base_url/api/projects
GET base_url/api/trainings

    Following Query Strings are available
    title, tags, category(trainings) limit and offset

  2. Add new project details

    POST base_url/api/projects
POST base_url/api/trainings

  3. Delete project Details

    DELETE base_url/api/projects?title=
DELETE base_url/api/trainings?title=

  4. Update project Details

    PUT base_url/api/projects?title=
PUT base_url/api/trainings?title=

war's People

Contributors

suryasr007 avatar dependabot[bot] avatar

Stargazers

Charan Teja avatar

Watchers

James Cloos avatar avatar Arijit Basu avatar Charan Teja avatar

war's Issues

Initial Update

The bot created this issue to inform you that pyup.io has been set up on this repo.
Once you have closed it, the bot will open pull requests for updates as soon as they are available.

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.