{"id":13832095,"url":"https://github.com/aureleoules/core","last_synced_at":"2025-07-09T16:33:54.740Z","repository":{"id":101683784,"uuid":"179327081","full_name":"aureleoules/core","owner":"aureleoules","description":"Backpulse's core. Backpulse is an API Based CMS. Build you own website without worrying about the content administration system.","archived":true,"fork":false,"pushed_at":"2020-03-29T16:18:29.000Z","size":99,"stargazers_count":68,"open_issues_count":0,"forks_count":10,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-08-05T10:20:09.490Z","etag":null,"topics":["api","api-based","backpulse","cms","golang","headless-cms"],"latest_commit_sha":null,"homepage":"https://backpulse.aureleoules.com","language":"Go","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/aureleoules.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-04-03T16:17:19.000Z","updated_at":"2023-04-27T12:50:09.000Z","dependencies_parsed_at":"2024-01-15T15:46:15.256Z","dependency_job_id":null,"html_url":"https://github.com/aureleoules/core","commit_stats":null,"previous_names":["backpulse/core"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aureleoules%2Fcore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aureleoules%2Fcore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aureleoules%2Fcore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aureleoules%2Fcore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aureleoules","download_url":"https://codeload.github.com/aureleoules/core/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225575171,"owners_count":17490711,"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":["api","api-based","backpulse","cms","golang","headless-cms"],"created_at":"2024-08-04T10:01:50.808Z","updated_at":"2024-11-20T14:30:26.781Z","avatar_url":"https://github.com/aureleoules.png","language":"Go","readme":"[![forthebadge](https://forthebadge.com/images/badges/made-with-go.svg)](https://forthebadge.com)\n[![forthebadge](https://forthebadge.com/images/badges/powered-by-netflix.svg)](https://forthebadge.com)\n\n[![Donate](https://img.shields.io/badge/Donate-Crypto-blue.svg)](https://commerce.coinbase.com/checkout/b4d64264-dda8-41d0-9f15-0843f969fa79)\n[![Donate](https://img.shields.io/badge/Donate-Patreon-orange.svg)](https://www.patreon.com/backpulse)\n[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/aureleoules)\n\n![Backpulse](https://files.backpulse.io/backpulse.png#cache2 \"Backpulse.io\")\n\n# Backpulse core\nBackpulse is an API Based / Headless CMS.  \nYour site's content is accessible directly via our RESTful API, on any web framework and any device.  \n\n## Installation\nWith a correctly configured Go toolchain:\n```bash\ngo get github.com/backpulse/core\n```\n\n## Build\u0026Run from source\nWith a correctly configured(go version \u003e=go1.11) Go toolchain: \n```bash\ngit clone https://github.com/backpulse/core\ncd core\nmake build\n./backpulse\n``` \n\n## Docker Build\u0026Run\n```bash\ndocker build -t \u003cyour-backpulse-tag\u003e .\ndocker run -d --link \u003cmongodb-container\u003e:mongodb \u003cyour-backpulse-tag\u003e\n```\nor docker run in custom environment\n```bash\ndocker run -d \\\n           --link \u003cmongodb-container\u003e:mongodb \\\n           --env MONGODB_URI=mongodb://mongodb:27017 \\\n           --env DATABASE=backpulse \\\n           \u003cyour-backpulse-tag\u003e\n```\n\n## Usage\nFirst, you need to create a config.json using the `config.json.template` file.\n* **URI** : MongoDB server address (_mongodb://..._)\n* **Database** : MongoDB database name\n* **Secret** : A secret key to encrypt JWT\n* **GmailAddress** : A gmail address if you wish to send confirmation emails\n* **GmailPassword** : The password associated with the gmail address obviously\n* **StripeKey** : Your Stripe Key if you wish to integrate Stripe\n* **BucketName** : Your Google Cloud Storage Bucket's name to store user files (images, binaries, plain text...)\n\nYou can also pass all these variables as environment variables:\n* MONGODB_URI\n* DATABASE\n* SECRET\n* GMAIL_ADDRESS\n* GMAIL_PASSWORD\n* STRIPE_KEY\n* BUCKET_NAME  \n\n\n**Note**: If a `config.json` file is found, it will override environment variables.\n\nThen, you need to get your Google Service Account Key:\n* Go to this [page](https://console.cloud.google.com/apis/credentials/serviceaccountkey).\n* Create a new account with the Project -\u003e Owner role.\n* Download your private key as JSON.\n* Move it to the root of this project.\n* Rename it `google_credentials.json`.\n\nYou can also pass the content of this json file as an environment variable:\n\nGOOGLE_APPLICATION_CREDENTIALS = `{\"type\": \"service_account\", \"project_id\": \"projectID\", ...}`\n\nYou're all set to run **Backpulse**!\n```bash\ngo build -o backpulse \u0026\u0026 backpulse\n```\n\n**Note**: By default Backpulse runs on port 8000, but can be overridden with the `PORT` environment variable.\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n\n## License \n[MIT](https://github.com/backpulse/core/blob/master/LICENSE) © [Aurèle Oulès](https://www.aureleoules.com)","funding_links":["https://www.patreon.com/backpulse","https://www.paypal.me/aureleoules"],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faureleoules%2Fcore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faureleoules%2Fcore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faureleoules%2Fcore/lists"}