{"id":20398159,"url":"https://github.com/ateliware/uploader","last_synced_at":"2025-05-08T12:30:38.291Z","repository":{"id":71159857,"uuid":"90151142","full_name":"ateliware/uploader","owner":"ateliware","description":"The uploader service you desperately need!","archived":true,"fork":false,"pushed_at":"2024-01-16T16:47:06.000Z","size":14,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-20T15:36:01.385Z","etag":null,"topics":["gcs","google-cloud-storage","upload","uploader"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ateliware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-05-03T13:18:53.000Z","updated_at":"2024-11-07T16:33:43.000Z","dependencies_parsed_at":"2023-02-22T13:16:06.456Z","dependency_job_id":null,"html_url":"https://github.com/ateliware/uploader","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/ateliware%2Fuploader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ateliware%2Fuploader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ateliware%2Fuploader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ateliware%2Fuploader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ateliware","download_url":"https://codeload.github.com/ateliware/uploader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253068311,"owners_count":21848780,"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":["gcs","google-cloud-storage","upload","uploader"],"created_at":"2024-11-15T04:19:08.576Z","updated_at":"2025-05-08T12:30:38.011Z","avatar_url":"https://github.com/ateliware.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# uploader\n\n[![Build Status](https://travis-ci.org/ateliware/uploader.svg?branch=master)](https://travis-ci.org/ateliware/uploader)\n\nThe ateliware default uploader app. This is a simple web app with\ntwo routes:\n\n- `GET /token` - this route gives the user a unique authentication\ntoken to upload one file. The tokens are automatically expired in 3\nhours. You can optionally make this an authenticated route, for more\ninformation see the [configuration section](#configuration) below.\n- `POST /upload` - this route uploads a file to the storage service\nconfigured.  This route takes two required params: `file`, which is\nthe file you want to upload, and `token` which is the authentication\ntoken to your upload (generated by `GET /token`).\n\n## Configuration\n\nAll the configuration for the app is done through environment variables,\nso here we go:\n\n- `NODE_ENV` - the environment to run the app. Can be one of:\n  - `development` - to use on your local environment only\n  - `test` - to use on your test environment and CI\n  - `production` - to use on your production deployed app\n- `PORT` - the port used to start the server on\n- `UPLOADER_USER` - the username to use in the authentication system for\nthe `GET \\token` route.\n- `UPLOADER_PSWD` - the password to use in the authentication system for\nthe `GET \\token` route.\n\nThe following keys are required only in production environment:\n\n- `BUCKET` - the storage bucket to upload to\n- `PROJECT_ID` - the project id where the bucket is on\n- `KEYFILE` - the credentials for your storage server\n\n## Contribute to the app\n\nHere is how to install and contribute for this project. But before\nthinking in anything new to place in this app:\n\nPLEASE, KEEP IT SIMPLE. ;)\n\n### Installing the app in dev mode\n\nHere is a step by step for installing the app and running its main\ntasks:\n\n- First of all `git clone git@github.com:ateliware/uploader.git`\n- Then `cd uploader`\n- Now you can choose from doing it with our without docker so the\nnext steps will have details for both\n- Install the dependencies\n  - **docker** - `docker build . -t uploader`\n  - **no-docker** - `npm install`\n- Running the server (with monitoring):\n  - **docker** - `docker run -e NODE_ENV=development -p 3000:3000\n  -v .:/app uploader`\n  - **no-docker** - `npm start`\n  - If you want to start the server monitoring file changes:\n    - **docker** - `docker run -e NODE_ENV=development -p 3000:3000\n    -v .:/app uploader nodemon index.js`\n    - **no-docker** - `nodemon index.js`\n- The default port of the project is `3000`, so you can use the\nserver in [`http://localhost:3000`](http://localhost:3000)\n- Running the tests:\n  - **docker** - `docker run -e NODE_ENV=test uploader npm test`\n  - **no-docker** - `npm test`\n\n### Workflow\n\n1. Create a new branch for your feature of fix and checkout to it\n2. Do your code\n3. Run the tests\n4. Add a commit to it (only if the tests passed, and prefer tiny\nchunks of code per commit, it's easier to review this way)\n5. Repeat 2 to 4 until it's done\n6. Open a PR\n7. Someone else will review it\n  1. If needed, fix what the reviewer asked for\n8. DONE!\n\n### Deploying\n\nThe deploy of this app consists in building and pushing a docker\nimage to hub.docker.com.\n\n#### Building and pushing the image\n\n- Upgrade the version in [`package.json`](./package.json) with:\n  - `VERSION=$(npm version major | cut -c 2-)` when you make incompatible API changes\n  - `VERSION=$(npm version minor | cut -c 2-)` when you add functionality in a\n  backwards-compatible manner\n  - `VERSION=$(npm version patch | cut -c 2-)` when you make backwards-compatible\n  bug fixes\n  - For more details in about versioning, [read this](http://semver.org)\n- Build the docker image `docker build -t ateliware/uploader:$VERSION .`\n- Publish to docker hub `docker push ateliware/uploader:$VERSION`\n- SHIP IT! :shipit:\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fateliware%2Fuploader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fateliware%2Fuploader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fateliware%2Fuploader/lists"}