https://github.com/victorstein/covid-backend
Yet another covid-19 backend
https://github.com/victorstein/covid-backend
covid-backend typegraphql
Last synced: 15 days ago
JSON representation
Yet another covid-19 backend
- Host: GitHub
- URL: https://github.com/victorstein/covid-backend
- Owner: victorstein
- Created: 2020-08-09T02:33:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-06T03:01:33.000Z (over 4 years ago)
- Last Synced: 2025-04-14T22:49:03.009Z (15 days ago)
- Topics: covid-backend, typegraphql
- Language: TypeScript
- Homepage: https://yetanother-covid-api.herokuapp.com/graphql
- Size: 194 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# COVID-19 TypeGraphQL API
This is yet another COVID-19 API but with a sprinkle of TypeGraphQL into the mix to spice things up.
## Live Example
You may find a live example of the API and a runing GraphQL Playground [Here](https://yetanother-covid-api.herokuapp.com/graphql).
## Installation
* Clone the repo
```git clone https://github.com/victorstein/covid-backend.git```
* Enter the repo directory
```cd covid-backend```
* Install the dependencies
```npm install```
* Create a .env file with the following set up. (examples in parentheses)
| KEY | TYPE | DESCRIPTION | REQUIRED
| ------ | ------ | ------ | ---------
PORT |Int| Server Port | False
NODE_ENV |String| Node environment | False
API_KEY |string| API key to use with [COVID-19](https://rapidapi.com/api-sports/api/covid-193) API | True
ALLOWED_ORIGINS | comma separated String | for example, http:// localhost, https://frontend.com | False
* Finally, just run ```npm run dev``` for development, ```npm run build``` for webpack, or ```npm start``` (once built) to run from the dist folder
## Contributing
Feel free to submit your PRs for review. There's currently no template for contribution. As the project grows we will look into further implementation of this.
## Deployment
If any further deployment of the API is needed feel free to contact the Repo owner. If you have access to the heroku app, you may add it to your remotes and usse the deployment scripts in package.json.
## Authors
Alfonso Gomez
💬 📖🔧 👀 😎
## License
This project is licensed under the ISC License