https://github.com/samsoft00/getir-restful-api-challenge
Develop restful api to fetch records within a timeframe
https://github.com/samsoft00/getir-restful-api-challenge
Last synced: 11 months ago
JSON representation
Develop restful api to fetch records within a timeframe
- Host: GitHub
- URL: https://github.com/samsoft00/getir-restful-api-challenge
- Owner: samsoft00
- Created: 2021-01-17T14:38:22.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-18T10:50:02.000Z (over 5 years ago)
- Last Synced: 2025-04-04T15:14:56.437Z (about 1 year ago)
- Language: JavaScript
- Size: 228 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Getir Restful Api Challenge
Develop restful api to fetch records within a date range
## Requirements
* The code should be written in Node.js using express framework ✅
* The endpoint should just handle HTTP POST requests. ✅
* The application should be deployed on AWS or Heroku. You don’t need to use any API Gateway, Load Balancers or any other layer than the developed application. ✅
* The up to date repo should be publicly available in Github, Bitbucket or equivalent. ✅
## Deliverables
* Public repo URL: https://github.com/samsoft00/getir-restful-api-challenge.git
* The public endpoint URL (POST): https://tranquil-reaches-53695.herokuapp.com/v1/getir-records
## Local Setup
To setup on local machine, kindly run the following command.
- `git clone https://github.com/samsoft00/getir-restful-api-challenge.git getir-sam-task`
- `cd getir-sam-task`
- `npm i`
- `cp .env.example .env`
- `npm run start:dev`
Note: Before your run `npm run start:dev`, ensure you declare your environment variable in `.env` file.
```
PORT=8000 # port
NODE_ENV= # dev or production
MONGODB_URI = # getir-case-study MongoDb name
MONGODB_NAME = # getir-case-study MongoDb URL
```
## Code Styling
Used "JavaScript Standard Style" for linter & automatic code fixer
Link here -> https://github.com/standard/standard
## Test
```
npm run test
```
