## 1. Project Overview & Quickstart (feathersjs/LICENSE) # LICENSE Open-source repository feathersjs/LICENSE ### Repository Details - **Repository:** [feathersjs/LICENSE](https://github.com/feathersjs/LICENSE) - **Primary Language:** Code *Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.* ## 2. Official Technical Reference & Guides (feathersjs/website) ## File: README.md Feathers ================== > The marketing site for FeathersJS ## Getting Started 1. Install nodejs and npm 2. Run `npm install` 3. Run `npm run watch` 4. Go to [http://localhost:8080](http://localhost:8080/) in your browser Now you can start editing content. Your content will automatically be rebuilt when things change and since we are using livereload your browser will automatically update with your changes. ## Building Simply run `npm run build` to build the site, which runs through the appropriate gulp tasks. ## Deploying The site currently gets deployed to [Netlify](https://www.netlify.com). In order to do this simplly commit to the master branch and it will kick off a build and Netlify will run the `npm run build` command. This will clean out any old files, rebuild the site with the production config, and deploy it. ## Structure ### `content/` Contains the raw html and markdown pages for the site. These get compiled with the `layouts` and moved to the `build/` directory. ### `assets/` This is where all the static assets live that end up getting compiled and/or copied to the `build/` directory. This includes: - scripts - images - styles - templates/layouts - fonts - any other static files ### `config/` This directory holds the config values for production and development environments. ### `build/` These are all the files that get deployed to Netlify. --- ## File: package.json { "name": "feathers-site", "version": "2.0.0", "description": "The Feathers marketing website", "private": true, "license": "MIT", "author": { "name": "Feathers contributors", "email": "hello@feathersjs.com", "url": "https://feathersjs.com" }, "contributors": [ "Eric Kryski (http://erickryski.com)", "David Luecke (http://neyeon.com)" ], "homepage": "https://feathersjs.com", "repository": { "type": "git", "url": "git://github.com/feathersjs/feathers-website.git" }, "bugs": { "url": "https://github.com/feathersjs/feathers-website/issues" }, "engines": { "node": ">= 0.12.x", "npm": ">= 2.5.x" }, "keywords": [ "feathers" ], "main": "", "scripts": { "clean": "rm -rf build/", "watch": "gulp", "build": "npm run clean; gulp build; gulp sitemap", "postinstall": "npm run build", "test": "gulp" }, "dependencies": { "del": "^1.2.0", "expose-loader": "^0.6.0", "gulp": "^3.9.0", "gulp-changed": "^1.3.0", "gulp-connect": "^5.0.0", "gulp-data": "^1.2.0", "gulp-front-matter": "^1.2.3", "gulp-if": "^2.0.0", "gulp-imagemin": "^2.3.0", "gulp-less": "^3.0.3", "gulp-markdown": "^1.0.0", "gulp-minify-css": "^1.2.0", "gulp-notify": "^2.2.0", "gulp-sitemap": "^2.2.0", "highlight.js": "^8.8.0", "jquery": "^2.1.3", "lodash": "^3.8.0", "require-dir": "^0.3.0", "swig": "^1.4.2", "through2": "^2.0.0", "typewriter-js": "0.0.6", "velocity-animate": "^1.2.2", "webpack": "^1.10.5", "webpack-stream": "^2.1.0" } } --- ## File: assets/robots.txt User-agent: * Disallow: --- ## File: config/development.json { "site": { "baseUrl": "http://localhost:8080", "title": "Feathers - A framework for real-time applications and REST APIs", "description": "Feathers is a web-framework for creating real-time applications and REST APIs using JavaScript or TypeScript with Node.JS, React Native and the browser.", "keywords": "feathers, web, framework, nestjs, sails, loopback, server, websocket, application, client, API, Firebase, Parse, Horizon, real-time, backend, socket.io, typescript, javascript, sql, nosql, sql server, mysql, postgres, postgresql, mongo, mongodb, sqlite, sqllite, redis, nedb, mongoose, sequelize", "author": { "name": "Feathers contributors", "twitter": "feathersjs" }, "ga": { "id": "UA-64904930-2" }, "twittercard": { "card": "summary_large_image", "site": "@feathersjs", "title": "Feathers - A framework for real-time applications and REST APIs", "description": "Feathers is a web-framework for creating real-time applications and REST APIs using JavaScript or TypeScript with Node.JS, React Native and the browser.", "creator": "@daffl", "image": "/img/twitter-card-image.png" }, "facebookgraph": { "title": "Feathers - A framework for real-time applications and REST APIs", "type": "product", "image": "/img/facebook-share-image.png", "description": "Feathers is a web-framework for creating real-time applications and REST APIs using JavaScript or TypeScript with Node.JS, React Native and the browser", "siteName": "Feathers", "updatedTime": "2020-08-02T11:08:47+01:00", "richAttachment": "true", "brand": "Feathers", "category": "Software", "admins": "517607527" } } } --- ## File: config/production.json { "site": { "baseUrl": "https://feathersjs.com", "title": "Feathers - A framework for real-time applications and REST APIs", "description": "Feathers is a web-framework for creating real-time applications and REST APIs using JavaScript or TypeScript with Node.JS, React Native and the browser.", "keywords": "feathers, web, framework, nestjs, sails, loopback, server, websocket, application, client, API, Firebase, Parse, Horizon, real-time, backend, socket.io, typescript, javascript, sql, nosql, sql server, mysql, postgres, postgresql, mongo, mongodb, sqlite, sqllite, redis, nedb, mongoose, sequelize", "author": { "name": "Feathers contributors", "twitter": "feathersjs" }, "ga": { "id": "UA-64904930-1" }, "googleplus": { "name": "Feathers", "about": "An open source REST and realtime API layer for modern applications.", "description": "Wow your users. Build incredible real-time applications in record time.", "image": "/img/google-plus-share-image.png", "applicationCategory": "Server", "downloadUrl": "https://feathersjs.com", "featureList": "real-time, stripe, websocket, mongodb, mysql, postgres, sqlite", "operatingSystem": "Windows 7, Windows 8, OSX 10.6+, Linux", "author": "Eric Kryski" }, "twittercard": { "card": "summary_large_image", "site": "@feathersjs", "title": "Feathers - A framework for real-time applications and REST APIs", "description": "Feathers is a web-framework for creating real-time applications and REST APIs using JavaScript or TypeScript with Node.JS, React Native and the browser.", "creator": "@daffl", "image": "/img/twitter-card-image.png" }, "facebookgraph": { "title": "Feathers - A framework for real-time applications and REST APIs", "type": "product", "image": "/img/facebook-share-image.png", "description": "Feathers is a web-framework for creating real-time applications and REST APIs using JavaScript or TypeScript with Node.JS, React Native and the browser", "siteName": "Feathers", "updatedTime": "2020-08-02T11:08:47+01:00", "richAttachment": "true", "brand": "Feathers", "category": "Software", "admins": "517607527" } } } --- ## File: content/copyright.md --- layout: legal title: FeathersJS Copyright Policy class: copyright date: August 20th, 2015 --- FeathersJS respects the intellectual property rights of others and expects its users to do the same. Since we are based in Canada we don't have to comply with the Digital Millennium Copyright Act of 1998 (DMCA). With that said, we feel that taking things without permission and without attribution when required is not cool. So, FeathersJS, when served with notice as set out below, will ask that any persons that committed infringement using the FeathersJS software, website, or services (the "Services"), owned and operated by Bullish Ventures Ltd., remove their content. We also reserve the right to any additional action as set out in our [Terms of Use](/terms). If you are a copyright owner, authorized to act on behalf of one, or authorized to act under any exclusive right under copyright, please report alleged copyright infringements taking place on or through the Site by completing the following alleged infringement notice and delivering it to our designated copyright agent. #### Steps for Issuing Notice 1. Identify the copyrighted work that you claim has been infringed, or - if multiple copyrighted works are covered by this Notice - you may provide a representative list of the copyrighted works that you claim have been infringed. 2. Identify the material or link you claim is infringing (or the subject of infringing activity) and to which access is to be disabled, including at a minimum, if applicable, the URL of the link shown on the Site or the exact location where such material may be found. 3. Provide your company affiliation (if applicable), mailing address, telephone number, and, if available, email address. 4. Include both of the following statements in the body of the Notice: - _“I hereby state that I have a good faith belief that the disputed use of the copyrighted material is not authorized by the copyright owner, its agent, or the law (e.g., as a fair use).”_ - _“I hereby state that the information in this Notice is accurate and, under penalty of perjury, that I am the owner, or authorized to act on behalf of, the owner, of the copyright or of an exclusive right under the copyright that is allegedly infringed.”_ 5. Provide your full legal name and your electronic or physical signature. Deliver this Notice, with all items completed, to FeathersJS's Designated Copyright Agent: Copyright Agent FeathersJS c/o Bullish Ventures Ltd. 5026 22nd Avenue NW Calgary, AB T3B 0Y7 [legal@bullishventures.com](mailto:legal@bullishventures.com)