Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.23 KB
Raw

I am open to, and grateful for any contributions made by the community to help develop this project. Please go through this document once before you contribute or open a pull request.

Made With

  • Node and Express for the backend
  • React for the customization web tool
  • MonogDB as the database
  • Moongoose for interacting with MongoDB
  • Microsoft Azure for hosting

Directories

File or Folder Use
index.js Main entry file which starts the backend server
database mongo.js contains the database opertion, and schema.js contains the document schema
frontend React based customization web tool. The svgBadge.js in src folder creates the SVG badge for both the frontend and backend

config.json

This file should be created and placed in the same place as the index.js file. The content is as given below.

{
    "port": 3000,
    "mongourl": "mongodb://localhost/visitscounter"
}

Local Setup

  1. Clone this repo
  2. Run npm install once to install all dependencies.
  3. Run npm run site in one terminal window, and npm run server in another terminal window for testing.

Submission

Open a pull request with your changes describing in the best possible way what you have done.