ahaase / nutcracker-frontend-2022-server

nutcracker-frontend-2022-server

Setup

• Install docker
• Install node.js
• npm ci
• cp secret_key.default.js secret_key.js
• Enter secret key hash into secret_key.js
• cp pg_settings.default.js pg_settings.js
• Enter postgres password into pg_settings.js
• export POSTGRES_PASSWORD=examplepassword123 (has to be same password as in pg_settings)
• npm run db:start

Teardown

• npm run db:stop

Start server

Option 1: npm start

Option 2: npm run forever:start // To keep the server running

Other commands

npm run forever:list // List forever processes

npm run forever:stop // Stop forever process with ID 0. WARNING! This is not necessarily the correct forever process

API DOCS

There is a request limiter in place set to allow 10 requests per 10 seconds.

To use any endpoint you need to include an API key in your headers:

headers['api-key'] = 'abcd1234'

Each API key gets some sample data upon first usage.

Item

List items

GET /api/item

Query options:

offset: Integer,
limit: Integer // 1-128

Example: GET /api/item?offset=96&limit=32

---

Retrieve item

GET /api/item/<ID>

---

Create item

POST /api/item

Payload options:

{
  description: String,
  do_before: Integer
}

---

Update item

PUT /api/item/<ID>

Payload options:

{
  description: String,
  do_before: Integer,
  done: Boolean
}

---

Delete item

DELETE /api/item/<ID>

---

Session

Create a new session

Requires a special api-key set. Its hash should match the value in file src/secret_key.js

POST /api/session/new

Payload options:

{
  count: Integer // Default: 1
}

---