{"id":15011544,"url":"https://github.com/tikservices/syteup","last_synced_at":"2025-10-24T12:40:25.298Z","repository":{"id":20650401,"uuid":"23932452","full_name":"tikservices/syteup","owner":"tikservices","description":"A simple but powerful packaged personal site that has social integrations like Facebook, Google+, GitHub, Dribbble, Instagram, Tumblr, Wordpress, Linkedin, Last.fm, SoundCloud, Bitbucket, StackOverflow, Flickr","archived":false,"fork":false,"pushed_at":"2016-09-08T13:20:44.000Z","size":18565,"stargazers_count":2,"open_issues_count":6,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-18T11:53:46.949Z","etag":null,"topics":["bootstrap3","css3","handlebars","javascript","lesscss","social-services","website"],"latest_commit_sha":null,"homepage":"http://lejenome.github.io/syteup","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tikservices.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":"2014-09-11T19:24:48.000Z","updated_at":"2020-02-13T20:34:27.000Z","dependencies_parsed_at":"2022-09-20T04:12:03.735Z","dependency_job_id":null,"html_url":"https://github.com/tikservices/syteup","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/tikservices/syteup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tikservices%2Fsyteup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tikservices%2Fsyteup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tikservices%2Fsyteup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tikservices%2Fsyteup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tikservices","download_url":"https://codeload.github.com/tikservices/syteup/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tikservices%2Fsyteup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002398,"owners_count":26083373,"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","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["bootstrap3","css3","handlebars","javascript","lesscss","social-services","website"],"created_at":"2024-09-24T19:41:13.833Z","updated_at":"2025-10-10T01:17:42.641Z","avatar_url":"https://github.com/tikservices.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Syteup\n\n**Syteup** (a complete rewrite of [Syte](https://github.com/rigoneri/syte)) is a\nreally simple but powerful packaged personal site that has social integrations\nlike GitHub, Dribbble, Instagram, Tumblr, Wordpress,\nLinkedin, Last.fm, SoundCloud, Bitbucket, StackOverflow, Flickr.\n\n# Demo\n\nYou can see Syteup in action on [my personal website](http://lejenome.github.io/).\n\nA more up to date but less stable version is available\n[here](http://lejenome.github.io/syteup/demo).\n\n## Social Integrations\n\n### Blog\n\nSyteup use [Tumblr](http://tumblr.com), [Wordpress.com](http://wordpress.com/)\nor [Blogger](https://www.blogger.com/) for blogging and your blog will be the\nprimary page of the site.\n\n![Syteyp Wordpress](docs/imgs/screenshot-blog-wordpress.png)\n\n### Social Services\n\nSuteup currently support many different social services:\n\n**[Github](https://github.com/)**\n\n![Syteyp Github](docs/imgs/screenshot-github.png)\n\n**[Flickr](https://www.flickr.com/)**\n\n![Syteyp Flickr](docs/imgs/screenshot-flickr.png)\n\n**[SoundCloud](https://soundcloud.com/)**\n\n![Syteyp SoundCloud](docs/imgs/screenshot-soundcloud.png)\n\n**[Last.fm](http://www.last.fm/)**\n\n![Syteyp Last.fm](docs/imgs/screenshot-lastfm.png)\n\n**[StackOverflow](http://stackoverflow.com/)**\n\n![Syteyp StackOverflow](docs/imgs/screenshot-stackoverflow.png)\n\n**[Bitbucket](https://bitbucket.org/)**\n\n![Syteyp Bitbucket](docs/imgs/screenshot-bitbucket.png)\n\n**[Dribbble](https://dribbble.com/)**\n\n![Syteyp Dribbble](docs/imgs/screenshot-dribbble.png)\n\n**[Instagram](http://instagram.com/)**\n\n![Syteyp Instagram](docs/imgs/screenshot-instagram.png)\n\n**[Youtube](https://www.youtube.com/)**\n\n![Syteyp Youtube](docs/imgs/screenshot-youtube.png)\n\n**[LinkedIn](https://www.linkedin.com/)**\n\n![Syteyp LinkedIn](docs/imgs/screenshot-linkedin.png)\n\n**[Facebook](https://www.facebook.com/)**\n\n![Syteyp Facebook](docs/imgs/screenshot-facebook.png)\n\n**[Google+](https://plus.google.com/)**\n\n![Syteyp Google+](docs/imgs/screenshot-gplus.png)\n\nSome other services integration is planed. For more up to date list of currently\nsupported services and planed services isavailable on\n[TODO.md](https://github.com/lejenome/syteup/tree/master/TODO.md) file.\n\nNOTE: Some services can not be supported as accessing them from client side will\ngive crackers full access to your account (e.g: Twitter, Foursquare) or the service provider does not support\nserver side requirements (e.g: neither SOP nor jsonp are supported by Steam,...),\nif you want them to be implemented, ask the service provider to supported limited\npermission access tokens or other needed requirements.\n\n## Installation\n\nSyteup dose not require  any specific server side future as it is server-less\nmoder HTML5 webapp.\n\nFirst, you need to setup Syteup requirements by runnig the following commands:\n```shell\nnpm install\nbower update\n```\nthen, you needs to rename\n[src/config.json.sample](https://github.com/lejenome/syteup/tree/master/src/config.json.sample)\nfile to `config.json` and customize it for your needs as explained on the\nflowing section then run\n```shell\nnpm run dist\n```\nwhich will update the\n[dist/](https://github.com/lejenome/syteup/blob/master/dist/)\nfolder with your new settings. Then copy the contents of [dist/](https://github.com/lejenome/syteup/blob/master/dist/)\nfolder to you server and then everything is ready.\n\nYou can also use make command for custom src and dist folder and config file\ntoo.\n```shell\nmake -j1 SRC=~/syteup/src DIST=/srv/website/www CONF=~/my_config.json\n```\n\n## Setup\n\n**IN PROGRESS**\n\n### General Setup\n\n\nChange all avatars images on [src/imgs](src/imgs) folder (pic.png, favicon.ico,\napple-touch-icon\\*.png) by your avatar images with same sizes.\n\nSetup the options of `fields` object on `config.json` file\n\n```javascript\n\"fields\": {\n  \"username\": String, // the pseudonym (nickname) you mostly known by\n  \"realname\": String, // your complete real name\n  \"description\": String, // a very short 'About Me' line\n  \"url\": String, // the url of your website\n  \"contact\": {\n    \"email\": String, // your email\n    \"mobile\": String, // [optional] your phone number e.g: (216) 00000000\n    \"tel\": String, // [optional] your telephone number e.g: (216) 00000000\n    \"fax\": String, // [optional] your fax number e.g: (216) 1111111\n    \"address\": String, // [optional] just a short address e.g: Texas, USA\n    \"pgp_url\": String, // [optional] url of your public pgp key file on your site e.g: /pubkey.asc\n    \"fingerprint\": String, // [optional] your pgp key fingerprint e.g: 3A1D ADDD 332D 2EFB F816  21C3 84D8 5721 7365 9C9D\n    \"ssh_url\": String // [optional] your ssh public certificate file url on your site e.g: /id_rsa.pub\n  }\n```\n\n### Blog Setup\n\nSet `blog_platform` to the bloggin platform that you will use, availbale platforms\nare **\"tumblr\"** and **\"blogger\"** and **\"wordpress\"**.\n\nNext, you need to setup the options of the choosen platform on the\n`blogs_settings.\u003cplatform_name\u003e` object as follow:\n\n#### Wordpress\n\n```javascript\n\"wordpress\": {\n  \"blog_url\": String, // the url of your wordpress.com blog\n  \"tag_slug\": String // [optional] tags of posts to import (space separated)\n}\n```\n\n#### Blogger\n\n```javascript\n\"blogger\": {\n  \"blog_url\": String, // your blog url\n  \"blog_id\": String, // your blog id number (you can use https://developers.google.com/apis-explorer/#p/blogger/v3/blogger.blogs.getByUrl)\n  \"api_key\": String, // your api key (See Below)\n  \"tag_slug\": String // [optional] tags of posts to import (comma separated)\n}\n```\nSteps to get your `api_key` are explained on the youtube section below.\n\n#### Tumblr\n\n```javascript\n\"tumblr\": {\n  \"blog_url\": String, // your blog url\n  \"api_key\": String, // your api key (See Below)\n  \"tag_slug\": String // [optional] tag of posts to import (just one tag)\n}\n```\nTo get your `api_key`, register a new app [here](https://www.tumblr.com/oauth/register)\nwith any name and your website url as the default callback url. The \"OAuth\nConsumer Key\" of the application is your `api_key`.\n\n### Services Setup\n\nFor every service you would to enable, you should set `services.\u003cservice_name\u003e` on\n`config.json` file to `true` and setup it options object\n`services_settings.\u003cservice_name\u003e` on same file.\n\nDisabled services can safely removed from booth `services` and\n`services_settings` objects on the config file.\n\n#### Github\n\nenable `services.github` and configure `services_settings.github` as follow:\n```javascript\n\"github\": {\n  \"username\": String // your username\n}\n```\n\n#### StackOverflow\n\nenable `services.stackoverflow` and configure `services_settings.stackoverflow` as follow:\n```javascript\n\"stackoverflow\": {\n  \"username\": String, // your username\n  \"user_id\": String // your user id number\n}\n```\n\n#### Flickr\n\nenable `services.flickr` and configure `services_settings.flickr` as follow:\n```javascript\n\"flickr\": {\n  \"username\": String, // your username\n  \"user_id\": String // your user id (you can get it from http://idgettr.com/)\n}\n```\n\n#### Bitbucket\n\nenable `services.bitbucket` and configure `services_settings.bitbucket` as follow:\n```javascript\n\"bitbucket\": {\n  \"username\": String, // your username\n  \"show_forks\": Boolean // show number of forks (It require a http request for every repository\n}\n```\n\n#### SoundCloud\n\nenable `services.soundcloud` and configure `services_settings.soundcloud` as follow:\n```javascript\n\"soundcloud\": {\n  \"username\": String, // your username\n  \"client_id\": String, // your client_id (See Below)\n  \"show_artwork\": Boolean, // show tracks artworks\n  \"player_color\": String // color of tracks player\n}\n```\nTo get an `client_id`, register an app [here](http://soundcloud.com/you/apps)\nwith any name you want, after you accept their Developer Policies, you get your\nClient ID.\n\n#### Last.fm\n\nenable `services.lastfm` and configure `services_settings.lastfm` as follow:\n```javascript\n\"lastfm\": {\n  \"username\": String, // your username\n  \"api_key\": String // your api key (See Below)\n}\n```\nTo get an `api_key`, register a non comercial account\n[here](http://www.last.fm/api/account/create) with any name and a small\ndescription, then you will get your API Key.\n\n#### Dribbble\n\nenable `services.dribbble` and configure `services_settings.dribbble` as follow:\n```javascript\n\"dribbble\": {\n  \"username\": String // your username\n}\n```\n\n#### Youtube\n\nenable `services.youtube` and configure `services_settings.youtube` as follow:\n```javascript\n\"youtube\": {\n  \"username\": String, // your username\n  \"api_key\": String // your api key (See Below)\n}\n```\nTo get an `api_key`, create a project\n[here](https://console.developers.google.com/) with any name then click \"Enable\nan API\" and enable the API you need (\"YouTube Data API v3\" for YouTube,\n\"Blogger API v3\" for Blogger, \"Google+ API\" for Google+). Then on \"Cendentials\"\ntab, click \"Create a new Key\" then \"Browser Key\" and enter your website url then\n\"Create\" to get your API KEY.\n\n#### Google+\n\nenable `services.gplus` and configure `services_settings.gplus` as follow:\n```javascript\n\"gplus\": {\n  \"user_id\": String, // your user id number\n  \"api_key\": String // your api key (See Below)\n}\n```\nSteps to get your `api_key` are explained on the youtube section above.\n\n#### Facebook\n\nenable `services.facebook` and configure `services_settings.facebook` as follow:\n```javascript\n\"facebook\": {\n  \"username\": String, // your username\n  \"access_token\": String // your access token key (See Below)\n}\n```\nto get you read only `access_token`, create a web application\n[here](https://developers.facebook.com/quickstarts/?platform=web). Then, choose\nit from \"Application\" menu from this\n[page](https://developers.facebook.com/tools/explorer/) and click \"Get Access\nToken\" and select booth \"user_activities\", \"user_about_me\" and \"user_status\".\nAfter confirming, you will get your final `access_token` on the Access Token\nfield.\n\n#### Instagram\n\nenable `services.instagram` and configure `services_settings.instagram` as follow:\n```javascript\n\"instagram\": {\n  \"username\": String, // your username\n  \"access_token\": String, // your access token key (TODO: NEED MORE DOCUMENTATION)\n  \"user_id\": String // your user id number\n}\n```\n\n#### LinkedIn\n\nenable `services.linkedin` and configure `services_settings.linkedin` as follow:\n```javascript\n\"linkedin\": {\n  \"username\": String, // your username\n  \"access_token\": String // your access token key (See Below)\n}\n```\nTo get your read only `access_token`, register a new app\n[here](https://www.linkedin.com/secure/developer). Select \"r_basicprofile\" and\n\"r_fullprofile\" as your default scopes and add\n`http://lejenome.me/tests/syteup-settings/linkedin.html?client_id=\u003cYOUR_API_KEY\u003e\u0026client_secret=\u003cYOUR_SECRET_API\u003e`\nto \"OAuth 2.0 Redirect URLs\" after replacing the two parameters with your\nAPI Key and your Secret Key. Then use this\n[link](http://lejenome.me//tests/syteup-settings/linkedin.html) to request your access token.\n\n### Plugins setup\n\nEnabling a plugin depend on the type of plugin, either it's a generic plugin or\na blog plugin. For generic plugins, set `plugins.\u003cplugin_name\u003e` to `true`. and\nfor blogs plugins, set `blogs_settings.plugins.\u003cplugin_name\u003e` to `true`.\n\nSettings of every plugin are availbale on the `plugins_settings.\u003cplugin_name\u003e`\nobject on `config.json` file as follow:\n\n#### Disqus\n\nThis plugin will enable disqus comments on every post. Just\nenable `blogs_settings.plugins.disqus` and configure `plugins_settings.disqus` as follow:\n```javascript\n\"disqus\": {\n  \"url\": String, // [optional] your disqus profile url\n  \"shortname\": String, // your username\n  \"just_count\": Boolean // [optional] just show the number of comments instead of the 'Show Comments' buttons\n}\n```\n\n#### ShareThis\n\nThis plugin will add ShareThis widget to every post. Just\nenable `blogs_settings.plugins.sharethis` and configure `plugins_settings.sharethis`\nas follow:\n```javascript\n\"sharethis\": {\n  \"publisher_key\": String // your key\n}\n```\n\n#### RSS\n\nThis plugin will add RSS entry that any browser can subscribe to. Just\nenable `plugins.rss` and configure `plugins_settings.rss` as follow:\n```javascript\n\"rss\": {\n  \"url\": String // the url of your rss feed file or an external rss feed from your blog platform\n}\n```\n\n#### Google Analytics\n\nThis plugin will enable Google Analytics tracking. Just\nenable `plugins.google_analytics` and configure `plugins_settings.google_analytics`\n as follow:\n```javascript\n\"google_analytics\": {\n  \"tracking_id\": String // your tracking id e.g: UA-XXXXXXX-2\n}\n```\n\n#### Woopra\n\nThis plugin will enable Woopra tracking. Just\nenable `plugins.woopra` and configure `plugins_settings.woopra` as follow:\n```javascript\n\"woopra\": {\n  \"tracking_domain\": String, // TODO\n  \"idle_timeout\": Number, // TODO\n  \"include_query\": Boolean // TODO\n}\n```\n\n#### Segment\n\nThis plugin will enable Segment services. Just\nenable `plugins.segment` and configure `plugins_settings.segment` as follow:\n```javascript\n\"segment\": {\n  \"write_key\": String // your write key\n}\n```\n\n#### Gratipay Widget\n\nThis plugin will add Gratupay widget bollow the navigation menu. Just\nenable `plugins.gratipay_widget` and configure `plugins_settings.gratipay_widget`\nas follow:\n```javascript\n\"gratipay_widget\": {\n  \"username\": String // your gratipay username\n}\n```\n\n## Credit\n\n[Syteup](https://github.com/lejenome/syteup) is developed by\n[lejenome](https://github.com/lejenome) ([Moez Bouhlel](http://lejenome.github.io/))\nbased on [Syte](https://github.com/rigoneri/syte) by [Rigo](https://github.com/rigoneri)\n(rodrigo neri).\nThanks to [The Contributors](https://github.com/lejenome/syteup/graphs/contributors)\nfor booth the old Syte code and Syteup code.\n\n## Licence\n\nThis program is free software; it is distributed under the MIT Licence.\n\nCopyright (c) 2014, Moez Bouhlel (bmoez.j@gmail.com) \u0026 [The\nContributors](https://github.com/lejenome/syteup/graphs/contributors)\n\n\n[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/lejenome/syteup/trend.png)](https://bitdeli.com/free \"Bitdeli Badge\")\n[![Coverage Status](https://img.shields.io/coveralls/lejenome/syteup.svg)](https://coveralls.io/r/lejenome/syteup)\n[![Dependency Status](https://gemnasium.com/lejenome/syteup.svg)](https://gemnasium.com/lejenome/syteup)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftikservices%2Fsyteup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftikservices%2Fsyteup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftikservices%2Fsyteup/lists"}