Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mesaugat/tech-companies-in-nepal-api
Process diffs from tech-companies-in-nepal and push it into an Airtable.
https://github.com/mesaugat/tech-companies-in-nepal-api
airtable api nepal tech-companies tech-companies-in-nepal
Last synced: 18 days ago
JSON representation
Process diffs from tech-companies-in-nepal and push it into an Airtable.
- Host: GitHub
- URL: https://github.com/mesaugat/tech-companies-in-nepal-api
- Owner: mesaugat
- License: mit
- Created: 2017-03-26T16:57:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-21T06:54:30.000Z (about 2 months ago)
- Last Synced: 2024-10-12T07:48:59.845Z (about 1 month ago)
- Topics: airtable, api, nepal, tech-companies, tech-companies-in-nepal
- Language: JavaScript
- Homepage: https://tech-companies-in-nepal.herokuapp.com/api/companies
- Size: 593 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tech Companies in Nepal API
[](https://travis-ci.com/mesaugat/tech-companies-in-nepal-api)
Simple API to process diffs from [tech-companies-in-nepal](https://github.com/mesaugat/tech-companies-in-nepal) and push it into an [Airtable](https://airtable.com/shrXv3YvlfxLnHJfr).
## Installation
Clone the repository and install dependencies using [yarn](https://yarnpkg.com/en/)
```bash
$ git clone [email protected]:mesaugat/tech-companies-in-nepal-api.git
$ cd tech-companies-in-nepal-api
$ yarn
```
## For Production Environment
```bash
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
```bash
$ 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 `
## Contributing
For contribution and feature requests, please create an [issue](https://github.com/mesaugat/tech-companies-in-nepal-api/issues/new) first.
## License
tech-companies-in-nepal-api is under [MIT License](LICENSE.md).
---
__Most of the code has been taken from [hww-api](https://github.com/poteto/hww-api).__