https://github.com/vectormike/korapay-assessment
Stackoverflow API built with TypeScript, Knex, and MySQL.
https://github.com/vectormike/korapay-assessment
Last synced: 5 months ago
JSON representation
Stackoverflow API built with TypeScript, Knex, and MySQL.
- Host: GitHub
- URL: https://github.com/vectormike/korapay-assessment
- Owner: Vectormike
- License: mit
- Created: 2021-07-27T09:38:46.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-27T09:41:17.000Z (almost 5 years ago)
- Last Synced: 2025-02-02T06:41:28.272Z (over 1 year ago)
- Language: VBA
- Homepage:
- Size: 50.6 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stackoverflow API
This application allows you to register, login, ask Questions, reply and subscribe to Questions.
# STEPS TO RUN APP
### Step 1: Start up the containers
RUN `docker-compose up -d on the root directory of the project`
### RUN test in docker container
`docker exec -t -i app npm run test`
### Run Migration
`docker exec -t -i app knex migrate:latest`
### App Features
- Create a user account
- Login a user
- Fetch a list of all question
- Ask a question
- Answer a specific question
- Subscribe to a question
# Token Management
JWT was used for token along with redis for implementing refresh tokens
## View Application logs on Kibana
Logging was implemented with winton and elastic search
[Kibana board](http://localhost:5601/app/kibana#/discover)
#### POSTMAN API Documentation.
[Postman Api documentation](https://documenter.getpostman.com/view/5622145/TzsbLSvL)
#### Requirements not covered
- 85% test coverage not achieved