Code Monkey home page Code Monkey logo

startup-name-checker's Introduction

Startup Name Checker

Domain names and social media handles availability checker.

Setup

First, make sure you have Node.js installed.

Then, clone the repository and execute npm install or yarn in the local folder.

Run

Type npm start <startupName> or yarn start <startupName>.

Ex: yarn start awesomestartup.

Configure

You can configure the app by editing the config.json file. It has the following format:

{
  "domains": [
    ".com",
    ...
  ],
  "social": [
    { "name": "Facebook", "url": "https://www.facebook.com/{startupName}" },
    ...
  ],
  "requestTimeout": 5000
}

Add a domain check

Add an entry to the domains array. Ex: ".tv".

Add a social media check

Add an entry to the social array. The entry must be an object with the 2 following properties :

  • name: the name of the social network. Will be used when displaying results.
  • url: the URL pattern to check. Must include the {startupName} placeholder, which will be replaced by the name you supplied when running the app. The easiest way to find the URL pattern is to search for an existing company page on the desired social media.

Request timeout

Specify a value in milliseconds for requestTimeout. Should be short enough so that unresponsive web servers won't delay the display of the results for too long.

Remarks

The app was optimized for output readability instead of max performance. Instead of executing the HTTP calls in parallel and displaying the results as they arrive, the checks are here executed sequentially. This guarantees that all outputs will be in the exact same order, making it easier to compare them.

startup-name-checker's People

Contributors

mhajder avatar thibautvs avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

sourcingdenis

startup-name-checker's Issues

Publish package to npm

This package could be publish in npm to make it easier to install and use.

The name "startup-name-checker" is not used currently. It would be good to change the version from 1.0.0 to 0.1.0 before publishing unless the package is stable currently

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.