Tech Companies in Nepal API

Simple API to process diffs from tech-companies-in-nepal and push it into an Airtable.

Installation

Clone the repository and install dependencies using yarn

$ git clone git@github.com:mesaugat/tech-companies-in-nepal-api.git

$ cd tech-companies-in-nepal-api

$ yarn

For Production Environment

export PORT=4444
export AIRTABLE_BASE='dummy'
export AIRTABLE_API_KEY='dummy'
export GITHUB_WEBHOOK_SECRET='dummy'

Set the following environment variables and start the application using yarn start

For Test Environment

$ cp .env.example .env

Make a copy of .env.example as .env, update the API keys and test the application using yarn test

Scripts

The following commands are available:

Name	Description
start	Start application
lint	Run linter
lint:fix	Run linter and try to fix errors
test	Run tests

Run a command using yarn <command:name>

Contributing

For contribution and feature requests, please create an issue first.

License

tech-companies-in-nepal-api is under MIT License.

---

Most of the code has been taken from hww-api.