dfireBird / curlew

An API of sorts

curlew

Curlew is the API to manage a Team separated by cluster.

You can add members to the Team, add them to cluster, provide report and remarks.

Endpoints

Documentation on what an endpoint does is detailed on the docs folder The list of endpoints:

Authentication

More details here.

• POST /auth

Availability

More details here.

• GET /availability
• POST /availability
• GET /availability/desc
• POST /availability/desc
• GET /availabilities

Report

More details here.

• GET /reports
• POST /report

Social Media

More details here.

• GET /social
• POST /social

Events

More details here.

• GET /events
• POST /event

Images

More details here.

• GET /images
• POST /image

Resource

More details here.

• GET /resources
• POST /resource

Team Members

More details here.

• GET /team
• POST /team

Remarks

More details here.

• GET /remarks
• POST /remark

Deployment

Create a .env file with the following information:

POSTGRES_USER=<postrgres_username>
POSTGRES_PASSWORD=<postrgres_password>
POSTGRES_DB=<postgres_db_name>

Docker-Based

Prerequisite

• Docker
• docker-compose

Run the docker-compose to start the API server.

$ docker-compose up

Local Deployment (Without Docker)

Prerequisite

• postgres
• node version > 12
• yarn

Install the node dependencies

$ yarn

Ensure that you have postrgres installed and it’s running on your system then start the server.

$ yarn start

Usage

Navigate to localhost:8000 and access the endpoints

License

This project uses a MIT License, which can be viewed here here.