https://github.com/focusaurus/code-test-303-node

https://github.com/focusaurus/code-test-303-node

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/focusaurus/code-test-303-node
• Owner: focusaurus
• Created: 2018-08-20T21:30:17.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-08-20T21:46:26.000Z (almost 8 years ago)
• Last Synced: 2025-05-16T13:52:41.087Z (about 1 year ago)
• Language: JavaScript
• Size: 62.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# 303 Software Coding Test

## How to set up for development the first time

- Install docker and docker compose

- Clone this repo

- Build the docker image

  - `./bin/docker-build.sh`

- Get a shell in the api container

  - `./bin/docker-run.sh`

- create the database in docker

  - Run this command from your host shell

  - `docker-compose exec postgres su - postgres -c 'createdb api'`

- Load DB schema and seeds

  - `knex migrate:latest`

  - `knex seed:run`

## How to do normal development tasks

- Get a shell in the docker container

  - `./bin/docker-run.sh`

- start the server (from a shell in the container)

  - `npm start`

  - or `node .`

  - or `node-dev .`

- debug the server (from a shell in the container)

  - `node --inspect=0.0.0.0:9229 .`

  - On your host, run chrome and navigate to `chrome://inspect/#devices`

  - Click on "Remote Target > inspect"

- autoformat the code (from a shell in the container)

  - `npm run format`

- run the lint static analysis (from a shell in the container)

  - `npm run lint`

- Get a psql prompt (from a host shell)

  - `docker-compose exec postgres su - postgres -c 'psql api'`

## API Documentation

The server provides an HTTP interface at base URL `http://localhost:3000` when running locally. All v1 endpoints paths start with the prefix `/api/v1`.

**Posts**

- Create a post

  - HTTP Method: `POST`

  - Path: `/api/v1/posts`

  - JSON Body is an object with the following fields

    - `title` (string, required): The post title

    - `author` (string): The post author name or id

    - `content` (string): The post content (body text)

  - Response is JSON object with the new post fields

- View a post

  - HTTP Method: `GET`

  - Path: `/api/v1/posts/{postId}`

  - `postId` path field should be a positive integer

  - Response is JSON object with the post fields

- Update a post

  - HTTP Method: `PATCH`

  - Path: `/api/v1/posts/{postId}`

    - `postId` path field should be a positive integer

  - JSON Body is an object with the following fields

    - `title` (string, optional): The updated post title

    - `author` (string, optional): The updated post author name or id

    - `content` (string, optional): The updated post content (body text)

  - Response is JSON object with the updated post fields

- Delete a post

  - HTTP Method: `DELETE`

  - Path: `/api/v1/posts/{postId}`

  - `postId` path field should be a positive integer

  - Response is empty

## TODO Remaining Tasks

90 minutes is not a lot of time, so I skipped

- Input validation

  - optional vs required fields

  - string length limits

  - numeric ids

- Unit tests, especially for edge cases and error handling

- Pagination for the get all posts route

- API docs with a conventional tool like OpenAPI/Swagger