template_repo

Template Instructions

Use this template by clicking the green Use this template button above to create a new repository.

Couple of things to keep in mind:

• Make sure to set the owner to the DataPoint-Armenia org when creating.
• Name your repo in the format <project_name>_<repo_name>
  • For example: vortan_spellchecker.
  • This helps keep things organized when you have many repos for one project.
• This template is just a guideline. Feel free to change things up to suit your own needs.
  • I would start by deleting this "Template Instructions" section and filling in the other sections as the project develops.

About

Description of your project.

Documentation

A list of links to external documentation for your project

• Project Spec: link
• Technical Spec: link
• Google Drive Folder: link
• Slack Channel: #template

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

How to Guide

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

npm install

4. Enter your API in config.js

const API_KEY = 'ENTER YOUR API';

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

Contributors

• @poghos
• @petros
• @bardoghimyos

Achnowledgements

List all the resources you used such as papers, other repos, tutorials, etc

• othneildrew/Best-README-Template