{"id":18498637,"url":"https://github.com/nayracoop/courier-admin-api","last_synced_at":"2025-04-09T00:31:21.915Z","repository":{"id":37271445,"uuid":"243626341","full_name":"nayracoop/courier-admin-api","owner":"nayracoop","description":"REST api, built on top of Parse Server on Docker. Allows creation of Clients, Providers and Shippings. And is integrated with Xubio","archived":false,"fork":false,"pushed_at":"2022-12-09T01:16:12.000Z","size":395,"stargazers_count":4,"open_issues_count":15,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-23T19:51:29.972Z","etag":null,"topics":["cloud-functions","docker","parse-server","rest-api"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nayracoop.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-27T22:05:23.000Z","updated_at":"2022-10-15T08:24:11.000Z","dependencies_parsed_at":"2023-01-25T19:15:26.501Z","dependency_job_id":null,"html_url":"https://github.com/nayracoop/courier-admin-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nayracoop%2Fcourier-admin-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nayracoop%2Fcourier-admin-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nayracoop%2Fcourier-admin-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nayracoop%2Fcourier-admin-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nayracoop","download_url":"https://codeload.github.com/nayracoop/courier-admin-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247949896,"owners_count":21023411,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud-functions","docker","parse-server","rest-api"],"created_at":"2024-11-06T13:41:48.311Z","updated_at":"2025-04-09T00:31:20.310Z","avatar_url":"https://github.com/nayracoop.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Courier Admin API (built on top of Parse Server)\n\nParse Server with cloud functions. Has Docker support to run it with a containerized Mongo database and Parse Dashboard.\n\nIt's ment to be used in conjunction with the [Courier Admin Dashboard](https://github.com/nayracoop/courier-admin-dashboard).\n\n## Configuration\n\nConfiguration values, either to run the API with Docker or locally (E.g.: for ease of debug) must be placed in a **`.env`** file. You may use [.env-example](.env-example) as base.\n\n**`.env`** file is used by [dotenv](https://github.com/motdotla/dotenv) module to fill Node environment variables and with placeholders in the [docker-compose.yml](docker-compose.yml) file.\n\nKeys for different ports are included for Mongo, Parse Server and Parse Dashboard to be used on Docker containers. **`*_PORT`** references the port inside the container and **`*_LOCAL_PORT`** on the host machine.\n\n### Syncronization with Xubio\n\n[Xubio](https://xubio.com/) is an online commercial management tool.\nNew records created for Clients and Providers on the Courier Admin Dashboard are automatically syncronized with Xubio, by using [Parse Server's Cloud Functions](https://docs.parseplatform.org/cloudcode/guide/#cloud-functions). Creation of budgets and purchase orders are also supported using Cloud Functions, stored in the [cloud](/cloud) folder\n\nTo configure it:\n\n- You'd need a [PLUS or + subscription](https://xubio.com/ar/precios) to use Xubio's API.\n- Once there, get your API keys from the [integrations page](https://xubio.com/NXV/configuracion/integraciones/api-de-xubio)\n- **`Client_id`** and **`Secret_id`** are to be used on their corresponding **`.env`** keys: **`XUBIO_CLIENT_ID`** and **`XUBIO_SECRET`** respectivelly. Check [.env-example](.env-example) for an **`.env`** base.\n\n### Parse Server\n\nThe API is built on top of [Parse Server](https://parseplatform.org/). You may find example configuration values for your **`.env`** file as **`PARSE_SERVER_*`** keys in the [.env-example](.env-example).\n\n### Parse Dashboard\n\n**`docker-compose.yml`** includes a [Parse Dashboard](https://hub.docker.com/r/parseplatform/parse-dashboard) entry. You may find example configuration values for your **`.env`** file as **`PARSE_DASHBOARD_*`** keys in the [.env-example](.env-example).\n\nValues from **`PARSE_USER1`** and **`PARSE_USER1_PASSWORD`** from your **`.env`** file, are used to create user and password respectivelly to access Parse Dashboard.\n\n### Mongo DB\n\nDatabase is configured using **`MONGODB_URI`** key and **`DB_*`** keys. Please check [.env-example](.env-example) for examples.\n\n### UPS\n\nCommunication with UPS was planified but not implemented and it's not in our immediate plans to continue with it. **`UPS_`** keys for that integration still remain in the [.env-example](.env-example).\n\n## Development\n\n### Install\n\n- Clone and run **`npm install`**\n- Clone, configure and run the [Courier Admin Dashboard](https://github.com/nayracoop/courier-admin-dashboard.git) to have a working client for the API.\n\n### Use\n\n- In the configuration entry above you'll find details on how to complete your **`.env`** file.\n- Serve with [nodemon](https://nodemon.io/) using **`npm run dev`** :zap:\n\n### Database migrations\n\n- Migrations can be placed in [/tasks/migrations](/tasks/migrations) folder. To run them using [Jake](https://jakejs.com/) (and to run the initial migration, which works as example/template, and creates users), you may run **`npm run migrations`** :zap:\n\n### Use with Docker Compose\n\n- If you've got Docker and the docker-compose CLI installed, you may run **`docker-compose up`** to get a working API, Parse Server, Parse Dashboard and Mongo DB running. For more details check the [docker-compose.yml](docker-compose.yml) file and the [docker-compose documentation](https://docs.docker.com/compose/reference/up/).\n\n## License\n\n\u003cimg src=\"https://img.shields.io/badge/license-GPL--3-brightgreen\" alt=\"license GNU General Public License v3.0\"\u003e GNU General Public License v3.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnayracoop%2Fcourier-admin-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnayracoop%2Fcourier-admin-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnayracoop%2Fcourier-admin-api/lists"}