├── .dockerignore ├── .eslintrc.json ├── pages ├── api │ ├── graphql │ │ ├── resolvers │ │ │ └── index.ts │ │ ├── type-defs │ │ │ ├── inputs.ts │ │ │ ├── scalars.ts │ │ │ ├── queries.ts │ │ │ ├── index.ts │ │ │ ├── types.ts │ │ │ └── mutations.ts │ │ ├── queries │ │ │ └── index.ts │ │ ├── index.ts │ │ └── mutations │ │ │ └── index.ts │ ├── link │ │ └── [id].ts │ └── src │ │ └── generated-types.ts ├── _app.tsx ├── logout.tsx ├── login.tsx ├── dashboard │ ├── link │ │ ├── create.tsx │ │ └── [id].tsx │ ├── analytics.tsx │ └── index.tsx └── index.tsx ├── .github ├── FUNDING.yml └── workflows │ └── build-lint.yml ├── public ├── favicon.ico └── vercel.svg ├── docker ├── entrypoint.sh └── Dockerfile ├── resources └── singlelink-logo.png ├── postcss.config.js ├── .env.template ├── migrations ├── 0001-create-links.sql └── 0002-create-events.sql ├── tailwind.config.js ├── next-env.d.ts ├── .editorconfig ├── hooks ├── queries.graphql └── mutations.graphql ├── lib ├── connection.ts ├── graphql.ts └── models │ ├── Event.ts │ └── Link.ts ├── codegen.yml ├── .gitignore ├── tsconfig.json ├── styles ├── globals.css └── Home.module.css ├── docker-compose.yml ├── next.config.js ├── package.json ├── components ├── logo.tsx ├── dashboard.tsx └── logo-long.tsx ├── readme.md ├── logo-long.svg ├── hooks-generated └── index.ts └── license.md /.dockerignore: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "next/core-web-vitals" 3 | } 4 | -------------------------------------------------------------------------------- /pages/api/graphql/resolvers/index.ts: -------------------------------------------------------------------------------- 1 | export const Resolvers = { 2 | 3 | } -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # Want to help our mission? 2 | github: [singlelink-co] 3 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/singlelink-co/Singlelink/HEAD/public/favicon.ico -------------------------------------------------------------------------------- /docker/entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | npm i 3 | npm run build 4 | npm run db:migrate 5 | npm run start -------------------------------------------------------------------------------- /pages/api/graphql/type-defs/inputs.ts: -------------------------------------------------------------------------------- 1 | import { gql } from 'apollo-server-micro' 2 | 3 | export const inputs = gql`` -------------------------------------------------------------------------------- /pages/api/graphql/type-defs/scalars.ts: -------------------------------------------------------------------------------- 1 | import { gql } from 'apollo-server-micro' 2 | 3 | export const scalars = gql`` -------------------------------------------------------------------------------- /resources/singlelink-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/singlelink-co/Singlelink/HEAD/resources/singlelink-logo.png -------------------------------------------------------------------------------- /postcss.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | plugins: { 3 | tailwindcss: {}, 4 | autoprefixer: {}, 5 | }, 6 | } 7 | -------------------------------------------------------------------------------- /.env.template: -------------------------------------------------------------------------------- 1 | DB_DATABASE= 2 | DB_PORT= 3 | DB_HOST= 4 | DB_USER= 5 | DB_PASSWORD= 6 | META_TITLE= 7 | META_DESC= 8 | META_IMG= 9 | BRANDING= 10 | SECRET= 11 | PASSWORD= 12 | -------------------------------------------------------------------------------- /migrations/0001-create-links.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE IF NOT EXISTS links ( 2 | id int NOT NULL AUTO_INCREMENT PRIMARY KEY, 3 | label TEXT, 4 | content TEXT, 5 | type TEXT NOT NULL, 6 | position INT NOT NULL 7 | ); -------------------------------------------------------------------------------- /tailwind.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | content: [ 3 | "./pages/**/*.{js,ts,jsx,tsx}", 4 | "./components/**/*.{js,ts,jsx,tsx}", 5 | ], 6 | theme: { 7 | extend: {}, 8 | }, 9 | plugins: [], 10 | } 11 | -------------------------------------------------------------------------------- /next-env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | /// 3 | 4 | // NOTE: This file should not be edited 5 | // see https://nextjs.org/docs/basic-features/typescript for more information. 6 | -------------------------------------------------------------------------------- /docker/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node 2 | RUN git clone https://github.com/Neutron-Creative/Singlelink.git 3 | WORKDIR Singlelink 4 | RUN npm i --ignore-scripts 5 | 6 | COPY entrypoint.sh /entrypoint.sh 7 | 8 | EXPOSE 3000 9 | 10 | CMD ["/entrypoint.sh"] -------------------------------------------------------------------------------- /pages/api/graphql/type-defs/queries.ts: -------------------------------------------------------------------------------- 1 | import { gql } from 'apollo-server-micro' 2 | 3 | export const queries = gql` 4 | type Query { 5 | hello: String 6 | listLinks: [Link] 7 | findLinkById(id: Int!): Link 8 | fetchOverview: [Overview] 9 | } 10 | ` -------------------------------------------------------------------------------- /migrations/0002-create-events.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE IF NOT EXISTS events ( 2 | id int NOT NULL AUTO_INCREMENT PRIMARY KEY, 3 | type ENUM('view', 'click'), 4 | created_at TIMESTAMP NOT NULL DEFAULT current_timestamp, 5 | link_id INT REFERENCES links (id) 6 | ); -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # editorconfig.org 2 | root = true 3 | 4 | [*] 5 | indent_style = tab 6 | indent_size = 4 7 | end_of_line = lf 8 | charset = utf-8 9 | trim_trailing_whitespace = true 10 | insert_final_newline = true 11 | 12 | [*.md] 13 | trim_trailing_whitespace = false 14 | -------------------------------------------------------------------------------- /pages/api/graphql/type-defs/index.ts: -------------------------------------------------------------------------------- 1 | import { inputs } from './inputs' 2 | import { mutations } from './mutations' 3 | import { queries } from './queries' 4 | import { scalars } from './scalars' 5 | import { types } from './types' 6 | 7 | import {gql} from 'apollo-server-micro' 8 | 9 | export const typeDefs = [ 10 | queries, 11 | /*inputs, */ 12 | mutations, 13 | /*scalars,*/ 14 | types, 15 | ] -------------------------------------------------------------------------------- /pages/_app.tsx: -------------------------------------------------------------------------------- 1 | import '../styles/globals.css' 2 | import type { AppProps } from 'next/app' 3 | import { ApolloProvider } from '@apollo/client' 4 | 5 | import { client } from '../lib/graphql' 6 | 7 | function Singlelink({ Component, pageProps }: AppProps) { 8 | return ( 9 | 10 | 11 | 12 | ) 13 | } 14 | 15 | export default Singlelink 16 | -------------------------------------------------------------------------------- /hooks/queries.graphql: -------------------------------------------------------------------------------- 1 | query hello { 2 | hello 3 | } 4 | 5 | query listLinks { 6 | listLinks { 7 | id 8 | label 9 | content 10 | type 11 | position 12 | } 13 | } 14 | 15 | query findLinkById($id: Int!) { 16 | findLinkById(id: $id) { 17 | id 18 | label 19 | content 20 | type 21 | position 22 | } 23 | } 24 | 25 | query fetchOverview { 26 | fetchOverview { 27 | views 28 | clicks 29 | date 30 | } 31 | } -------------------------------------------------------------------------------- /lib/connection.ts: -------------------------------------------------------------------------------- 1 | const mysql = require('mysql2/promise') 2 | 3 | const client = mysql.createPool( 4 | process.env.DB_URL ?? { 5 | user: process.env.DB_USER ?? 'root', 6 | host: process.env.DB_HOST ?? '127.0.0.1', 7 | database: process.env.DB_DATABASE ?? 'singlelink', 8 | password: process.env.DB_PASSWORD ?? 'single-my-links', 9 | port: process.env.DB_PORT ?? 3306 10 | } 11 | ) 12 | 13 | // TODO: Add error handling if DB connection fails 14 | 15 | export default client 16 | 17 | -------------------------------------------------------------------------------- /codegen.yml: -------------------------------------------------------------------------------- 1 | schema: 'pages/api/graphql/type-defs/*.ts' # you can also point to a GraphQL endpoint! 2 | require: 3 | - ts-node/register 4 | generates: 5 | ./pages/api/src/generated-types.ts: 6 | config: 7 | withHooks: false 8 | plugins: 9 | - 'typescript' 10 | - 'typescript-react-apollo' 11 | ./hooks-generated/index.ts: 12 | documents: "./hooks/*.graphql" 13 | config: 14 | withHooks: true 15 | plugins: 16 | - "typescript" 17 | - "typescript-operations" 18 | - "typescript-react-apollo" -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | /.pnp 6 | .pnp.js 7 | 8 | # testing 9 | /coverage 10 | 11 | # next.js 12 | /.next/ 13 | /out/ 14 | 15 | # production 16 | /build 17 | 18 | # misc 19 | .DS_Store 20 | *.pem 21 | 22 | # debug 23 | npm-debug.log* 24 | yarn-debug.log* 25 | yarn-error.log* 26 | 27 | # local env files 28 | .env 29 | .env.local 30 | .env.development.local 31 | .env.test.local 32 | .env.production.local 33 | 34 | # vercel 35 | .vercel 36 | 37 | # typescript 38 | *.tsbuildinfo 39 | -------------------------------------------------------------------------------- /pages/api/graphql/type-defs/types.ts: -------------------------------------------------------------------------------- 1 | import { gql } from 'apollo-server-micro' 2 | 3 | export const types = gql` 4 | type Link { 5 | id: Int! 6 | label: String 7 | content: String 8 | type: String! 9 | position: Int! 10 | } 11 | enum EVENT_TYPE { 12 | click 13 | view 14 | } 15 | type Event { 16 | id: Int! 17 | type: EVENT_TYPE! 18 | created_at: String! 19 | link_id: Int! 20 | } 21 | type Overview { 22 | views: Int! 23 | clicks: Int! 24 | date: String! 25 | } 26 | ` -------------------------------------------------------------------------------- /pages/api/link/[id].ts: -------------------------------------------------------------------------------- 1 | import Link from "../../../lib/models/Link" 2 | import Event from "../../../lib/models/Event" 3 | import { Maybe } from "../../../hooks-generated" 4 | 5 | const handler = async (req: { query: { id: any } }, res: { redirect: (arg0: Maybe | undefined) => any }) => { 6 | const { id } = req.query 7 | if(!id) throw Error('Link ID needed to redirect') 8 | const link = await Link.findById(id) 9 | if(!link) throw Error(`Could not find Link with id ${id}`) 10 | const event = await Event.create('click', id) 11 | return res.redirect(link.content) 12 | } 13 | 14 | export default handler -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es5", 4 | "lib": ["dom", "dom.iterable", "esnext"], 5 | "allowJs": true, 6 | "skipLibCheck": true, 7 | "strict": true, 8 | "forceConsistentCasingInFileNames": true, 9 | "noEmit": true, 10 | "esModuleInterop": true, 11 | "module": "esnext", 12 | "moduleResolution": "node", 13 | "resolveJsonModule": true, 14 | "isolatedModules": true, 15 | "jsx": "preserve", 16 | "incremental": true 17 | }, 18 | "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "lib/migrate-db.mjs"], 19 | "exclude": ["node_modules"] 20 | } 21 | -------------------------------------------------------------------------------- /pages/api/graphql/type-defs/mutations.ts: -------------------------------------------------------------------------------- 1 | import { gql } from 'apollo-server-micro' 2 | 3 | export const mutations = gql` 4 | type Mutation { 5 | login(password: String): String 6 | verify(jwt: String): String 7 | createLink( 8 | label: String 9 | content: String 10 | type: String! 11 | ): Link 12 | updateLinkById( 13 | label: String 14 | content: String 15 | id: Int! 16 | position: Int! 17 | type: String! 18 | ): Link 19 | deleteLinkById(id: Int!): Link 20 | reorderLink(id: Int!, newIndex: Int!, oldIndex: Int!): [Link] 21 | createEvent(type: EVENT_TYPE): Event 22 | } 23 | ` -------------------------------------------------------------------------------- /pages/logout.tsx: -------------------------------------------------------------------------------- 1 | import type { NextPage } from 'next' 2 | import Head from 'next/head' 3 | import { useRouter } from 'next/router' 4 | import { useEffect, useState } from 'react' 5 | import Logo from '../components/logo' 6 | import { useLoginMutation } from '../hooks-generated' 7 | 8 | const Home: NextPage = () => { 9 | const router = useRouter() 10 | 11 | 12 | useEffect(() => { 13 | localStorage.setItem('jwt', '') 14 | router.push('/login') 15 | }) 16 | 17 | return ( 18 |
19 | 20 | Log out - Singlelink 21 | 22 | 23 | 24 |
25 | ) 26 | } 27 | 28 | export default Home 29 | -------------------------------------------------------------------------------- /lib/graphql.ts: -------------------------------------------------------------------------------- 1 | import { ApolloClient, concat, HttpLink, InMemoryCache } from '@apollo/client' 2 | import { setContext } from '@apollo/client/link/context' 3 | // @ts-ignore 4 | 5 | const authLink = setContext(async (_ : any, { headers } : { headers: any}) => { 6 | const jwt = await localStorage.getItem('jwt') 7 | 8 | const newContext: any = { 9 | headers: { 10 | ...headers, 11 | accept: 'application/json', 12 | }, 13 | } 14 | 15 | if (jwt) { 16 | newContext['headers'].authorization = `Bearer ${jwt}` 17 | } 18 | 19 | return newContext 20 | }) 21 | 22 | const httpLink = new HttpLink({ 23 | credentials: 'include', // Additional fetch() options like `credentials` or `headers` 24 | uri: '/api/graphql', 25 | }) 26 | 27 | export const client = new ApolloClient({ 28 | cache: new InMemoryCache(), 29 | link: concat(authLink, httpLink), 30 | }) -------------------------------------------------------------------------------- /styles/globals.css: -------------------------------------------------------------------------------- 1 | @import url('https://rsms.me/inter/inter.css'); 2 | 3 | @tailwind base; 4 | @tailwind components; 5 | @tailwind utilities; 6 | 7 | html, 8 | body { 9 | padding: 0; 10 | margin: 0; 11 | background-color: #F4F5F7; 12 | overflow-x: hidden; 13 | } 14 | 15 | a { 16 | color: inherit; 17 | text-decoration: none; 18 | } 19 | 20 | * { 21 | box-sizing: border-box; 22 | font-family: 'Inter', -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol" !important; 23 | } 24 | 25 | .embed-container { position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden; width: 100%; max-width: 100%; } .embed-container iframe, .embed-container object, .embed-container embed { position: absolute; top: 0; left: 0; width: 100%; height: 100%; } 26 | 27 | 28 | .h1 { 29 | @apply text-3xl font-semibold mb-8; 30 | } 31 | 32 | .h1-row > .h1 { 33 | margin-bottom: 0 !important 34 | } -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | # Use root/example as user/password credentials 2 | version: '3.1' 3 | 4 | services: 5 | singlelink: 6 | ports: 7 | - 3000:3000 8 | image: jimbisenius/singlelink 9 | depends_on: 10 | - mysql 11 | environment: 12 | DB_HOST: mysql 13 | DB_PORT: 3306 14 | DB_DATABASE: singlelink 15 | DB_USER: root 16 | DB_PASS: single-my-links 17 | META_TITLE: Singlelink 18 | META_DESC: My Singlelink Docker Instance. 19 | META_IMG: 20 | BRANDING: "true" 21 | 22 | SECRET: jwt_secret 23 | PASSWORD: password 24 | 25 | mysql: 26 | image: mysql 27 | # NOTE: use of "mysql_native_password" is not recommended: https://dev.mysql.com/doc/refman/8.0/en/upgrading-from-previous-series.html#upgrade-caching-sha2-password 28 | # (this is just an example, not intended to be a production configuration) 29 | command: --default-authentication-plugin=mysql_native_password 30 | restart: always 31 | environment: 32 | MYSQL_ROOT_PASSWORD: single-my-links 33 | MYSQL_DATABASE: singlelink -------------------------------------------------------------------------------- /pages/api/graphql/queries/index.ts: -------------------------------------------------------------------------------- 1 | import Link from '../../../../lib/models/Link' 2 | import Event from '../../../../lib/models/Event' 3 | 4 | export const Query = { 5 | hello : async () => { 6 | console.log('hello') 7 | return 'hello' 8 | }, 9 | listLinks: async (_: any, _params: any, context: { isAuthorized: boolean }) => { 10 | if(context.isAuthorized === false) throw Error('Must be authorized to use the Dashboard.') 11 | const links = await Link.list() 12 | return links 13 | }, 14 | findLinkById: async (_ : any, { id }: { id: number }, context: { isAuthorized: boolean }) => { 15 | if(!context.isAuthorized) throw Error('Must be authorized to use the Dashboard.') 16 | const link = await Link.findById(id) 17 | return link 18 | }, 19 | fetchOverview: async(_: any, _params: any, context: {isAuthorized: boolean}) => { 20 | if(!context.isAuthorized) throw Error('Must be authorized to use the Dashboard.') 21 | const overview = await Event.fetchOverview() 22 | return overview 23 | } 24 | } -------------------------------------------------------------------------------- /public/vercel.svg: -------------------------------------------------------------------------------- 1 | 3 | 4 | -------------------------------------------------------------------------------- /lib/models/Event.ts: -------------------------------------------------------------------------------- 1 | import client from '../connection' 2 | 3 | const Event = { 4 | create: async(type: 'click' | 'view', link_id?: string) => { 5 | const [insert] = !link_id ? await client.query(`insert into events (type) values(?)`, [type]) : await client.query(`insert into events (type, link_id) values(?, ?);`, ['click', link_id]) 6 | console.log(insert) 7 | if(!insert || insert.affectedRows < 1) throw Error('Failed to create link') 8 | const event = await client.query(`select * from events where id=?`, [insert.insertId]) 9 | return event[0] 10 | }, 11 | fetchOverview: async() => { 12 | const [overview] = await client.query(` 13 | select 14 | count(case when type = 'view' then 1 else null end) as views, 15 | count(case when type = 'click' then 1 else null end) as clicks, 16 | DATE(created_at) as date 17 | from events 18 | where created_at >= SUBDATE(CURDATE(), 7) 19 | group by DATE(created_at); 20 | `) 21 | if(!overview) throw Error('Failed to fetch overview') 22 | return overview 23 | } 24 | } 25 | 26 | export default Event -------------------------------------------------------------------------------- /.github/workflows/build-lint.yml: -------------------------------------------------------------------------------- 1 | # This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions 3 | 4 | name: Build & lint 5 | 6 | on: 7 | push: 8 | branches: 9 | - master 10 | pull_request: 11 | types: ['opened', 'edited', 'reopened', 'synchronize'] 12 | workflow_dispatch: 13 | 14 | jobs: 15 | build: 16 | runs-on: ubuntu-latest 17 | 18 | strategy: 19 | matrix: 20 | node-version: [16.x] 21 | # See supported Node.js release schedule at https://nodejs.org/en/about/releases/ 22 | 23 | steps: 24 | - uses: actions/checkout@v2 25 | - name: Use Node.js ${{ matrix.node-version }} 26 | uses: actions/setup-node@v2 27 | with: 28 | node-version: ${{ matrix.node-version }} 29 | cache: 'npm' 30 | - name: Installing dependencies 31 | run: npm i --ignore-scripts 32 | - name: Performing lint 33 | run: npm run lint 34 | - name: Generating build 35 | run: npm run build 36 | -------------------------------------------------------------------------------- /next.config.js: -------------------------------------------------------------------------------- 1 | /** @type {import('next').NextConfig} */ 2 | const nextConfig = { 3 | reactStrictMode: true, 4 | env: { 5 | DB_USER: process.env.DB_USER, 6 | DB_HOST: process.env.DB_HOST, 7 | DB_DATABASE: process.env.DB_DATABASE, 8 | DB_PASSWORD: process.env.DB_PASSWORD, 9 | DB_PORT: process.env.DB_PORT, 10 | META_TITLE: (process.env.BRANDING !== 'false') ? (process.env.META_TITLE ?? 'Under construction') + ' - Singlelink' : (process.env.META_TITLE ?? 'Under construction'), 11 | META_DESC: (process.env.BRANDING !== 'false') ? (process.env.META_DESC ?? 'Another micro-site waiting to be built!') + ' Built with Singlelink.' : (process.env.META_DESC ?? 'Another micro-site waiting to be built!'), 12 | META_IMG: process.env.META_IMG ?? 'https://singlelink.co/og-image-updated.jDB_', 13 | BRANDING: (process. env.BRANDING !== 'false') ?? true, 14 | SECRET: process.env.SECRET, 15 | PASSWORD: process.env.PASSWORD 16 | }, 17 | experimental: { 18 | outputStandalone: true 19 | }, 20 | // TODO: TEMPORARY SOLUTION FOR COMPONENT _APP.TSX BUILD ERRORS REMOVE 21 | typescript: { 22 | ignoreBuildErrors: true 23 | } 24 | } 25 | 26 | module.exports = nextConfig -------------------------------------------------------------------------------- /pages/api/graphql/index.ts: -------------------------------------------------------------------------------- 1 | // Import third-party dependencies 2 | import { ApolloServer, gql } from 'apollo-server-micro' 3 | import { MicroRequest } from 'apollo-server-micro/dist/types'; 4 | import { ServerResponse } from 'http'; 5 | const cors = require('micro-cors')(); // highlight-line 6 | const { send } = require('micro'); 7 | 8 | 9 | // Import first-party dependencies 10 | import { Mutation } from './mutations' 11 | import { Query } from './queries' 12 | import { Resolvers } from './resolvers' 13 | import { typeDefs } from './type-defs' 14 | const jwt = require('jsonwebtoken') 15 | 16 | export const resolvers = { 17 | Mutation, 18 | Query, 19 | //...Resolvers 20 | } 21 | 22 | const server = new ApolloServer({ 23 | typeDefs, 24 | resolvers, 25 | context: ({ req }) => { 26 | if(req.headers.authorization) { 27 | const token = req.headers.authorization.substr(7, req.headers.authorization.length-7) || '' 28 | try { 29 | const decoded = jwt.verify(token, process.env.SECRET) 30 | } catch { 31 | return { isAuthorized: false} 32 | } 33 | return { isAuthorized: true } 34 | } else return {} 35 | } 36 | }) 37 | 38 | const startServer = server.start() 39 | 40 | export const config = { 41 | api: { 42 | bodyParser: false 43 | } 44 | } 45 | 46 | export default cors(async(req: MicroRequest, res: ServerResponse) => { 47 | if (req.method === "OPTIONS") { 48 | res.end(); 49 | return false; 50 | } 51 | 52 | await startServer; 53 | await server.createHandler({ path: "/api/graphql" })(req, res); 54 | }) -------------------------------------------------------------------------------- /hooks/mutations.graphql: -------------------------------------------------------------------------------- 1 | mutation login( 2 | $password: String! 3 | ) { 4 | login( 5 | password: $password 6 | ) 7 | } 8 | 9 | mutation verify( 10 | $jwt: String! 11 | ) { 12 | verify( 13 | jwt: $jwt 14 | ) 15 | } 16 | 17 | mutation createLink( 18 | $label: String 19 | $content: String 20 | $type: String! 21 | ) { 22 | createLink( 23 | label: $label, 24 | content: $content, 25 | type: $type 26 | ) { 27 | id 28 | label 29 | content 30 | type 31 | position 32 | } 33 | } 34 | 35 | mutation updateLinkById( 36 | $label: String 37 | $content: String 38 | $id: Int! 39 | $position: Int! 40 | $type: String! 41 | ) { 42 | updateLinkById( 43 | label: $label, 44 | content: $content, 45 | id: $id, 46 | position: $position, 47 | type: $type 48 | ) { 49 | id 50 | label 51 | content 52 | type 53 | position 54 | } 55 | } 56 | 57 | mutation deleteLinkById($id: Int!) { 58 | deleteLinkById(id: $id) { 59 | id 60 | label 61 | content 62 | type 63 | position 64 | } 65 | } 66 | 67 | mutation reorderLink($id: Int!, $newIndex: Int!, $oldIndex: Int!) { 68 | reorderLink(id: $id, newIndex: $newIndex, oldIndex: $oldIndex) { 69 | label 70 | content 71 | id 72 | position 73 | type 74 | } 75 | } 76 | 77 | mutation createEvent($type: EVENT_TYPE) { 78 | createEvent(type: $type) { 79 | id 80 | type 81 | created_at 82 | } 83 | } -------------------------------------------------------------------------------- /styles/Home.module.css: -------------------------------------------------------------------------------- 1 | .container { 2 | padding: 0 2rem; 3 | } 4 | 5 | .main { 6 | min-height: 100vh; 7 | padding: 4rem 0; 8 | flex: 1; 9 | display: flex; 10 | flex-direction: column; 11 | justify-content: center; 12 | align-items: center; 13 | } 14 | 15 | .footer { 16 | display: flex; 17 | flex: 1; 18 | padding: 2rem 0; 19 | border-top: 1px solid #eaeaea; 20 | justify-content: center; 21 | align-items: center; 22 | } 23 | 24 | .footer a { 25 | display: flex; 26 | justify-content: center; 27 | align-items: center; 28 | flex-grow: 1; 29 | } 30 | 31 | .title a { 32 | color: #0070f3; 33 | text-decoration: none; 34 | } 35 | 36 | .title a:hover, 37 | .title a:focus, 38 | .title a:active { 39 | text-decoration: underline; 40 | } 41 | 42 | .title { 43 | margin: 0; 44 | line-height: 1.15; 45 | font-size: 4rem; 46 | } 47 | 48 | .title, 49 | .description { 50 | text-align: center; 51 | } 52 | 53 | .description { 54 | margin: 4rem 0; 55 | line-height: 1.5; 56 | font-size: 1.5rem; 57 | } 58 | 59 | .code { 60 | background: #fafafa; 61 | border-radius: 5px; 62 | padding: 0.75rem; 63 | font-size: 1.1rem; 64 | font-family: Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, 65 | Bitstream Vera Sans Mono, Courier New, monospace; 66 | } 67 | 68 | .grid { 69 | display: flex; 70 | align-items: center; 71 | justify-content: center; 72 | flex-wrap: wrap; 73 | max-width: 800px; 74 | } 75 | 76 | .card { 77 | margin: 1rem; 78 | padding: 1.5rem; 79 | text-align: left; 80 | color: inherit; 81 | text-decoration: none; 82 | border: 1px solid #eaeaea; 83 | border-radius: 10px; 84 | transition: color 0.15s ease, border-color 0.15s ease; 85 | max-width: 300px; 86 | } 87 | 88 | .card:hover, 89 | .card:focus, 90 | .card:active { 91 | color: #0070f3; 92 | border-color: #0070f3; 93 | } 94 | 95 | .card h2 { 96 | margin: 0 0 1rem 0; 97 | font-size: 1.5rem; 98 | } 99 | 100 | .card p { 101 | margin: 0; 102 | font-size: 1.25rem; 103 | line-height: 1.5; 104 | } 105 | 106 | .logo { 107 | height: 1em; 108 | margin-left: 0.5rem; 109 | } 110 | 111 | @media (max-width: 600px) { 112 | .grid { 113 | width: 100%; 114 | flex-direction: column; 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "singlelink", 3 | "private": false, 4 | "version": "4.1.0", 5 | "homepage": "https://singlelink.co", 6 | "license": "GPL-3.0-or-later", 7 | "scripts": { 8 | "dev": "next dev", 9 | "build": "next build", 10 | "build:docker": "docker build -t jimbisenius/singlelink ./docker", 11 | "start": "next start", 12 | "lint": "next lint", 13 | "generate": "graphql-codegen --config codegen.yml --watch", 14 | "postinstall": "npx migrate-mysql", 15 | "db:migrate": "npx migrate-mysql", 16 | "boot:app": "docker pull singlelink | docker run --name singlelink-app -p 3000:3000 singlelink", 17 | "boot:db": "docker pull mysql | docker run --name singlelink-mysql -e MYSQL_DATABASE=singlelink -p 3306:3306 -e MYSQL_ROOT_PASSWORD=single-my-links -d mysql:latest" 18 | }, 19 | "dependencies": { 20 | "@apollo/client": "^3.5.8", 21 | "apollo-server-micro": "^3.6.3", 22 | "dotenv-run-script": "^0.2.0", 23 | "graphql": "15.7.2", 24 | "html-react-parser": "^1.4.8", 25 | "jsonwebtoken": "^8.5.1", 26 | "micro": "^9.3.4", 27 | "micro-cors": "^0.1.1", 28 | "mysql-await": "^2.1.8", 29 | "mysql2": "^2.3.3", 30 | "next": "latest", 31 | "next-absolute-url": "^1.2.2", 32 | "react": "^17.0.2", 33 | "react-beautiful-dnd": "^13.1.0", 34 | "react-dom": "^17.0.2", 35 | "ts-node": "^10.5.0" 36 | }, 37 | "devDependencies": { 38 | "@graphql-codegen/cli": "^2.6.2", 39 | "@graphql-codegen/typescript": "1.22.0", 40 | "@graphql-codegen/typescript-operations": "1.17.16", 41 | "@graphql-codegen/typescript-react-apollo": "^3.2.2", 42 | "@graphql-codegen/typescript-resolvers": "1.18.0", 43 | "@types/node": "^17.0.17", 44 | "@types/react": "17.0.39", 45 | "@types/react-beautiful-dnd": "^13.1.2", 46 | "autoprefixer": "^10.4.2", 47 | "camelize-ts": "^1.0.8", 48 | "eslint": "8.8.0", 49 | "eslint-config-next": "12.0.10", 50 | "graphql-codegen": "^0.4.0", 51 | "migrate-mysql": "^0.4.0", 52 | "postcss": "^8.4.6", 53 | "tailwindcss": "^3.0.21", 54 | "typescript": "4.5.5" 55 | }, 56 | "bugs": { 57 | "url": "https://github.com/Neutron-Creative/Singlelink/issues", 58 | "email": "jim@neutroncreative.com" 59 | }, 60 | "repository": { 61 | "type": "git", 62 | "url": "git+https://github.com/Neutron-Creative/Singlelink.git" 63 | }, 64 | "author": { 65 | "name": "Jim Bisenius", 66 | "email": "jim@neutroncreative.com", 67 | "url": "https://twitter.com/jim_bisenius" 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /pages/api/graphql/mutations/index.ts: -------------------------------------------------------------------------------- 1 | import Link from "../../../../lib/models/Link"; 2 | import Event from "../../../../lib/models/Event"; 3 | import { MutationLoginArgs } from "../../src/generated-types"; 4 | 5 | const jwt = require("jsonwebtoken"); 6 | 7 | export const Mutation = { 8 | login: async(_: any, 9 | { password }: MutationLoginArgs, 10 | _context: any) => { 11 | if(password===process.env.PASSWORD) { 12 | const token = jwt.sign({}, process.env.SECRET, 13 | { 14 | expiresIn: '24h' 15 | }) 16 | // Return jwt 17 | return token 18 | } else { 19 | throw Error(`Incorrect password provided, please try again.`) 20 | } 21 | }, 22 | verify: async(_: any, 23 | params: { jwt: any; }, 24 | _context: any) => { 25 | const decoded = jwt.verify(params.jwt, process.env.SECRET) 26 | return params.jwt 27 | }, 28 | createLink: async(_: any, 29 | params: { label: string, content: string, type: string}, { isAuthorized }: { isAuthorized: boolean }) => { 30 | if(!isAuthorized) throw Error('Must be authorized to use the Dashboard.') 31 | const link = await Link.create(params) 32 | return link 33 | }, 34 | updateLinkById: async(_: any, 35 | params: { label: string, content: string, id: number, position: number, type: string}, { isAuthorized }: { isAuthorized: boolean }) => { 36 | if(!isAuthorized) throw Error('Must be authorized to use the Dashboard.') 37 | const updatedLink = Link.updateById(params) 38 | return updatedLink 39 | }, 40 | deleteLinkById: async(_: any, 41 | { id}: { id: number }, { isAuthorized }: { isAuthorized: boolean }) => { 42 | if(!isAuthorized) throw Error('Must be authorized to use the Dashboard.') 43 | const link = Link.deleteById(id) 44 | return link 45 | }, 46 | reorderLink: async(_: any, 47 | { id, newIndex, oldIndex }: { id: number, newIndex: number, oldIndex: number }, 48 | { isAuthorized }: {isAuthorized: boolean}) => { 49 | if(!isAuthorized) throw Error('Must be authorized to use the Dashboard.') 50 | const links = await Link.reorder(id, newIndex, oldIndex) 51 | return links 52 | }, 53 | createEvent: async(_: any, { type } : { type: 'view' | 'click' }, context: {isAuthorized: boolean}) => { 54 | const event = await Event.create(type) 55 | return event 56 | } 57 | } -------------------------------------------------------------------------------- /pages/login.tsx: -------------------------------------------------------------------------------- 1 | import type { NextPage } from 'next' 2 | import Head from 'next/head' 3 | import { useRouter } from 'next/router' 4 | import { useEffect, useState } from 'react' 5 | import Logo from '../components/logo' 6 | import { useLoginMutation } from '../hooks-generated' 7 | 8 | const Home: NextPage = () => { 9 | const router = useRouter() 10 | const [password, setPassword] = useState('') 11 | 12 | const login = useLoginMutation({ 13 | fetchPolicy: 'network-only', 14 | onCompleted: async (data) => { 15 | if(data?.login) { 16 | console.log('data') 17 | console.log(data.login) 18 | await localStorage.setItem('jwt',data.login) 19 | return router.push('/dashboard') 20 | } else { 21 | console.log('else') 22 | console.log(data) 23 | } 24 | } 25 | }) 26 | 27 | useEffect(() => { 28 | const jwt = localStorage.getItem('jwt') 29 | if(jwt) router.push('/dashboard') 30 | }) 31 | 32 | return ( 33 |
34 | 35 | Login - Singlelink 36 | 37 | 38 | 39 | 40 |
41 |
42 |

Login to your Singlelink

43 |

Enter your credentials to access your account

44 | setPassword(e.target.value)} className='mb-4 px-5 py-3 rounded-lg border border-gray-200 w-full bg-white focus:ring-4 focus:ring-opacity-50 focus:ring-indigo-600 outline-0 ring-offset-2 focus:border-gray-1' type="password" placeholder="Password"/> 45 | 50 |
51 |
{alert('To reset your password, change the environment variable for PASSWORD in your SSH or terminal and restart your application.')}} className='text-gray-600 mt-12'>Forgot your password?Reset password
52 |
Copyright ©{new Date().getFullYear()} Neutron Creative Inc. All rights reserved.
53 | 54 |
55 | ) 56 | } 57 | 58 | export default Home 59 | -------------------------------------------------------------------------------- /pages/api/src/generated-types.ts: -------------------------------------------------------------------------------- 1 | import { gql } from '@apollo/client'; 2 | export type Maybe = T | null; 3 | export type Exact = { [K in keyof T]: T[K] }; 4 | export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; 5 | export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; 6 | /** All built-in and custom scalars, mapped to their actual values */ 7 | export type Scalars = { 8 | ID: string; 9 | String: string; 10 | Boolean: boolean; 11 | Int: number; 12 | Float: number; 13 | }; 14 | 15 | export enum Event_Type { 16 | Click = 'click', 17 | View = 'view' 18 | } 19 | 20 | export type Event = { 21 | __typename?: 'Event'; 22 | created_at: Scalars['String']; 23 | id: Scalars['Int']; 24 | link_id: Scalars['Int']; 25 | type: Event_Type; 26 | }; 27 | 28 | export type Link = { 29 | __typename?: 'Link'; 30 | content?: Maybe; 31 | id: Scalars['Int']; 32 | label?: Maybe; 33 | position: Scalars['Int']; 34 | type: Scalars['String']; 35 | }; 36 | 37 | export type Mutation = { 38 | __typename?: 'Mutation'; 39 | createEvent?: Maybe; 40 | createLink?: Maybe; 41 | deleteLinkById?: Maybe; 42 | login?: Maybe; 43 | reorderLink?: Maybe>>; 44 | updateLinkById?: Maybe; 45 | verify?: Maybe; 46 | }; 47 | 48 | 49 | export type MutationCreateEventArgs = { 50 | type?: Maybe; 51 | }; 52 | 53 | 54 | export type MutationCreateLinkArgs = { 55 | content?: Maybe; 56 | label?: Maybe; 57 | type: Scalars['String']; 58 | }; 59 | 60 | 61 | export type MutationDeleteLinkByIdArgs = { 62 | id: Scalars['Int']; 63 | }; 64 | 65 | 66 | export type MutationLoginArgs = { 67 | password?: Maybe; 68 | }; 69 | 70 | 71 | export type MutationReorderLinkArgs = { 72 | id: Scalars['Int']; 73 | newIndex: Scalars['Int']; 74 | oldIndex: Scalars['Int']; 75 | }; 76 | 77 | 78 | export type MutationUpdateLinkByIdArgs = { 79 | content?: Maybe; 80 | id: Scalars['Int']; 81 | label?: Maybe; 82 | position: Scalars['Int']; 83 | type: Scalars['String']; 84 | }; 85 | 86 | 87 | export type MutationVerifyArgs = { 88 | jwt?: Maybe; 89 | }; 90 | 91 | export type Overview = { 92 | __typename?: 'Overview'; 93 | clicks: Scalars['Int']; 94 | date: Scalars['String']; 95 | views: Scalars['Int']; 96 | }; 97 | 98 | export type Query = { 99 | __typename?: 'Query'; 100 | fetchOverview?: Maybe>>; 101 | findLinkById?: Maybe; 102 | hello?: Maybe; 103 | listLinks?: Maybe>>; 104 | }; 105 | 106 | 107 | export type QueryFindLinkByIdArgs = { 108 | id: Scalars['Int']; 109 | }; 110 | -------------------------------------------------------------------------------- /pages/dashboard/link/create.tsx: -------------------------------------------------------------------------------- 1 | import Head from 'next/head' 2 | import { useRouter } from 'next/router' 3 | import { useState } from 'react' 4 | import Dashboard from '../../../components/dashboard' 5 | import { useCreateLinkMutation } from '../../../hooks-generated' 6 | 7 | const LinkDetail = () => { 8 | const router = useRouter() 9 | const [label, setLabel] = useState() 10 | const [content, setContent] = useState() 11 | const [type, setType] = useState() 12 | const [loading, setLoading] = useState(false) 13 | 14 | const createLink = useCreateLinkMutation({ 15 | onCompleted: (data) => { 16 | router.push('/dashboard/') 17 | } 18 | }) 19 | 20 | const create = async () => { 21 | setLoading(true) 22 | createLink[0]({ 23 | variables: { 24 | label, 25 | content, 26 | type: type ?? 'vanilla' 27 | } 28 | }) 29 | } 30 | 31 | return ( 32 | 33 | 34 | Create link | Singlelink 35 | 36 |

Create new link

37 | {!loading ? 38 | <>
39 | 40 | setLabel(e.target.value)} value={label ?? ''} className='px-5 py-3 rounded-lg border border-gray-200 w-full bg-white focus:ring-4 focus:ring-opacity-50 focus:ring-indigo-600 outline-0 ring-offset-2 focus:border-gray-1' type='text' placeholder='e.g. My Instagram profile' /> 41 |
42 | 43 | 51 |
52 | 53 | setContent(e.target.value)} value={content ?? ''} className='px-5 py-3 rounded-lg border border-gray-200 w-full bg-white focus:ring-4 focus:ring-opacity-50 focus:ring-indigo-600 outline-0 ring-offset-2 focus:border-gray-1' type='text' placeholder='e.g. https://instagram.com/neutroncreative' /> 54 |
55 | 56 | :
Creating link, please wait...
57 | } 58 |
59 | ) 60 | } 61 | 62 | export default LinkDetail -------------------------------------------------------------------------------- /lib/models/Link.ts: -------------------------------------------------------------------------------- 1 | import { Link as LinkType } from '../../hooks-generated' 2 | import client from '../connection' 3 | 4 | const Link = { 5 | list: async (): Promise => { 6 | const [links] = await client.execute('select * from links order by position;') 7 | if(!links) throw Error('Failed to fetch links') 8 | return links 9 | }, 10 | findById: async (id: number): Promise => { 11 | const [link] = await client.execute('select * from links where id=?;', [id]) 12 | if(!link || !link[0]) throw Error('Failed to fetch link') 13 | return link[0] 14 | }, 15 | updateById: async(params: {label: string, content: string, id: number, position: number, type: string}): Promise => { 16 | const [update] = await client.execute(`update links set label=?, content=?, position=?, type=? where id=?;`, [params.label, params.content, params.position, params.type, params.id]) 17 | if(!update || update.affectedRows < 1) throw Error('Failed to update link') 18 | const link = await Link.findById(params.id) 19 | return link 20 | }, 21 | deleteById: async(id: number): Promise => { 22 | const link = await Link.findById(id) 23 | if(!link) throw Error('Failed to find link for deletion') 24 | const [deleted] = await client.execute(`delete from links where id=?;`, [id]) 25 | if(!deleted || deleted.affectedRows < 1) throw Error('Failed to delete link') 26 | return link 27 | }, 28 | findNextPosition: async (): Promise => { 29 | const links = await Link.list() 30 | let highestPosition = 0; 31 | for(let i=0;i highestPosition) highestPosition = links[i].position 33 | } 34 | return highestPosition+1 35 | }, 36 | create: async(params: {label: string, content: string, type: string}): Promise => { 37 | const nextPosition = await Link.findNextPosition() 38 | console.log(`Inserting new link at position ${nextPosition}`) 39 | const [inserted] = await client.execute(`insert into links (label, content, type, position) values(?, ?, ?, ?)`, [params.label, params.content, params.type,nextPosition]) 40 | if(!inserted || inserted.affectedRows < 1) throw Error('Failed to create link') 41 | const link = Link.findById(inserted.insertId) 42 | if(!link) throw Error('Failed to find new link.') 43 | return link 44 | }, 45 | reorder: async(id: number, newIndex: number, oldIndex: number): Promise => { 46 | let [queryResult] = await client.execute("select * from links order by position"); 47 | 48 | if (queryResult.length < 1) throw Error('Links not found to reorder') 49 | 50 | let linkRows: LinkType[] = queryResult; 51 | let linkRow: LinkType | undefined; 52 | 53 | if (oldIndex >= 0 && oldIndex < linkRows.length && newIndex >= 0 && newIndex < linkRows.length) { 54 | if (oldIndex < linkRows.length) { 55 | linkRow = linkRows[oldIndex]; 56 | } 57 | 58 | if (linkRow) { 59 | // Delete old index 60 | linkRows.splice(oldIndex, 1); 61 | 62 | // Insert at new index 63 | linkRows.splice(newIndex, 0, linkRow); 64 | } 65 | 66 | for (let i = 0; i < linkRows.length; i++) { 67 | linkRows[i].position = i; 68 | 69 | await client.execute("update links set position=? where id=?", [i, linkRows[i].id]); 70 | } 71 | let [queryResult] = await client.execute("select * from links order by position"); 72 | return queryResult 73 | } 74 | return queryResult.rows 75 | } 76 | } 77 | 78 | export default Link -------------------------------------------------------------------------------- /pages/dashboard/analytics.tsx: -------------------------------------------------------------------------------- 1 | import Head from 'next/head' 2 | import { useRouter } from 'next/router' 3 | import { useState } from 'react' 4 | import Dashboard from '../../components/dashboard' 5 | import { useFetchOverviewQuery, Event as EventType, FetchOverviewQuery, Overview } from '../../hooks-generated' 6 | 7 | 8 | const Analytics = () => { 9 | const [todayViews, setTodayViews] = useState(0) 10 | const [todayClicks, setTodayClicks] = useState(0) 11 | const [weeklyViews, setWeeklyViews] = useState(0) 12 | const [weeklyClicks, setWeeklyClicks] = useState(0) 13 | 14 | const overview = useFetchOverviewQuery({ 15 | onCompleted: (data: FetchOverviewQuery) => { 16 | let weekly = { 17 | views: 0, 18 | clicks: 0 19 | } 20 | if(!data.fetchOverview) throw Error('Fetch Overview not found') 21 | data.fetchOverview.map((analytics: any) => { 22 | weekly.views+=analytics.views 23 | weekly.clicks+=analytics.clicks 24 | }) 25 | if(data.fetchOverview.length>0) { 26 | setTodayViews((data.fetchOverview[data.fetchOverview.length - 1] as Overview).views) 27 | setTodayClicks((data.fetchOverview[data.fetchOverview.length - 1] as Overview).clicks) 28 | } 29 | setWeeklyViews(weekly.views) 30 | setWeeklyClicks(weekly.clicks) 31 | } 32 | }) 33 | 34 | return ( 35 | 36 | 37 | Analytics - Singlelink 38 | 39 |

Analytics

40 | {overview.data ? 41 | <> 42 |
43 |
Click-through rate (CTR)
44 |
{weeklyViews>1 ? `${((weeklyClicks/weeklyViews)*100).toFixed(2)} %` : '0%'}
45 |
46 |
47 |
48 |
Today's views
49 |
{(todayViews ?? 0).toLocaleString("en-US")}
50 |
51 |
52 |
Today's clicks
53 |
{(todayClicks ?? 0).toLocaleString("en-US")}
54 |
55 |
56 |
57 |
58 |
Weekly views
59 |
{(weeklyViews ?? 0).toLocaleString("en-US")}
60 |
61 |
62 |
Weekly clicks
63 |
{(weeklyClicks ?? 0).toLocaleString("en-US")}
64 |
65 |
66 | :
Loading, please wait...
67 | } 68 |
69 | ) 70 | } 71 | 72 | export default Analytics -------------------------------------------------------------------------------- /pages/dashboard/link/[id].tsx: -------------------------------------------------------------------------------- 1 | import Head from 'next/head' 2 | import { useRouter } from 'next/router' 3 | import { useState } from 'react' 4 | import Dashboard from '../../../components/dashboard' 5 | import { useDeleteLinkByIdMutation, useFindLinkByIdQuery, useUpdateLinkByIdMutation } from '../../../hooks-generated' 6 | import { Link } from '../../api/src/generated-types' 7 | 8 | const LinkDetail = () => { 9 | const router = useRouter() 10 | const { id } = router.query 11 | const [label, setLabel] = useState() 12 | const [content, setContent] = useState() 13 | const [type, setType] = useState() 14 | const [position, setPosition] = useState() 15 | const [loading, setLoading] = useState(true) 16 | 17 | const useFindLinkById = useFindLinkByIdQuery({ 18 | variables: { 19 | id: Number.parseInt(id as string ?? '') 20 | }, 21 | onCompleted: (data) => { 22 | if(!data.findLinkById?.id || !data.findLinkById?.type) throw Error('Singlelink: DB model invalid.') 23 | setLoading(false) 24 | setLabel(data.findLinkById.label ?? '') 25 | setContent(data.findLinkById.content ?? '') 26 | setType(data.findLinkById.type ?? 'vanilla') 27 | setPosition(data.findLinkById.position) 28 | } 29 | }) 30 | 31 | const updateLinkById = useUpdateLinkByIdMutation({ 32 | onCompleted: (data) => { 33 | setLoading(false) 34 | if(!document.getElementById('singlelink-preview')) return 35 | let iframe: HTMLIFrameElement = document.getElementById('singlelink-preview') as HTMLIFrameElement 36 | iframe.src = iframe.src 37 | } 38 | }) 39 | 40 | const deleteLinkById = useDeleteLinkByIdMutation({ 41 | onCompleted: (data) => { 42 | router.push('/dashboard/') 43 | } 44 | }) 45 | 46 | const attemptSave = async () => { 47 | if(position === undefined || position < 0 || !type || !id) throw Error('Cannot save without position, type, or id.') 48 | setLoading(true) 49 | updateLinkById[0]({ 50 | variables: { 51 | label, 52 | content, 53 | position, 54 | type, 55 | id: Number.parseInt(id as string) 56 | } 57 | }) 58 | } 59 | 60 | const attemptDelete = async () => { 61 | setLoading(true) 62 | deleteLinkById[0]({ 63 | variables: { 64 | id: Number.parseInt(id as string) 65 | } 66 | }) 67 | } 68 | 69 | return ( 70 | 71 | 72 | Edit link | Singlelink 73 | 74 |

Edit link

75 | {!loading ? 76 | <>
77 | 78 | setLabel(e.target.value)} value={label ?? ''} className='px-5 py-3 rounded-lg border border-gray-200 w-full bg-white focus:ring-4 focus:ring-opacity-50 focus:ring-indigo-600 outline-0 ring-offset-2 focus:border-gray-1' type='text' placeholder='e.g. My Instagram profile' /> 79 |
80 | 81 | 89 |
90 |
91 | 92 | setContent(e.target.value)} value={content ?? ''} className='px-5 py-3 rounded-lg border border-gray-200 w-full bg-white focus:ring-4 focus:ring-opacity-50 focus:ring-indigo-600 outline-0 ring-offset-2 focus:border-gray-1' type='text' placeholder='e.g. https://instagram.com/neutroncreative' /> 93 |
94 | 95 | 96 | :
Loading, please wait...
97 | } 98 |
99 | ) 100 | } 101 | 102 | export default LinkDetail -------------------------------------------------------------------------------- /pages/dashboard/index.tsx: -------------------------------------------------------------------------------- 1 | /* eslint-disable @next/next/no-img-element */ 2 | import type { NextPage } from 'next' 3 | import Head from 'next/head' 4 | import Link from 'next/link' 5 | import Image from 'next/image' 6 | import { useRouter } from 'next/router' 7 | import { useEffect, useState } from 'react' 8 | import Dashboard from '../../components/dashboard' 9 | import Logo from '../../components/logo' 10 | import LogoLong from '../../components/logo-long' 11 | import { Link as LinkType, useReorderLinkMutation, useVerifyMutation, useListLinksQuery } from '../../hooks-generated' 12 | import { DragDropContext, Droppable, Draggable, DropResult } from 'react-beautiful-dnd' 13 | 14 | const DashboardLinks = () => { 15 | const [links, setLinks] = useState() 16 | const router = useRouter() 17 | 18 | const listLinks = useListLinksQuery({ 19 | fetchPolicy: 'no-cache', 20 | onCompleted: (data) => { 21 | if(!data.listLinks) return 22 | setLinks(data.listLinks as LinkType[]) 23 | } 24 | }) 25 | 26 | const verify = useVerifyMutation({ 27 | onCompleted: (data) => { 28 | if(data?.verify) { 29 | localStorage.setItem('jwt', data?.verify) 30 | } else { 31 | localStorage.setItem('jwt', '') 32 | return router.push('/login') 33 | } 34 | } 35 | }) 36 | 37 | const reorder = useReorderLinkMutation({ 38 | onCompleted: (data) => { 39 | console.log(data) 40 | // Sync data with remote 41 | if(!data.reorderLink) return 42 | setLinks(data.reorderLink as LinkType[]) 43 | // Reload IFrame 44 | if(!document.getElementById('singlelink-preview')) return 45 | let iframe: HTMLIFrameElement = document.getElementById('singlelink-preview') as HTMLIFrameElement 46 | iframe.src = iframe.src 47 | } 48 | }) 49 | 50 | const reorderLinks = async(result: DropResult) => { 51 | const id=Number.parseInt(result.draggableId ?? '') 52 | const newIndex = result.destination?.index ?? -1 53 | const oldIndex = result.source.index 54 | console.log(`Dragging link ${id} to ${newIndex} from ${oldIndex}`) 55 | console.log(result) 56 | if(id && newIndex >=0 && oldIndex >= 0) { 57 | // Attempt reorder 58 | console.log('Attempting reorder...') 59 | reorder[0]({ 60 | variables: { 61 | id, 62 | newIndex, 63 | oldIndex 64 | } 65 | }) 66 | } 67 | } 68 | 69 | useEffect(() => { 70 | if(!localStorage.getItem('jwt')) { 71 | router.push('/login') 72 | } 73 | },[]) 74 | 75 | return ( 76 | 77 | 78 | Dashboard - Singlelink 79 | 80 |
81 |

Links

82 | 83 | 87 | 88 |
89 | {!reorder[1].loading ? 90 | 91 | 92 | {(provided: any) => ( 93 |
    94 | {(links ?? []).map((link, i) => ( 95 | 96 | {(provided: any) => ( 97 |
  • router.push(`/dashboard/link/${link?.id}`)}> 98 |
    99 | {link?.label &&
    {link?.label}
    } 100 |
    101 | {link?.type} 102 | | 103 | {link?.content?.substring(0, 32) + '...' ?? 'N/A'} 104 |
    105 |
    106 |
  • 107 | )} 108 |
    109 | ))} 110 |
111 | )} 112 |
113 |
:

Loading links...

114 | } 115 |
116 | ) 117 | } 118 | 119 | export default DashboardLinks -------------------------------------------------------------------------------- /pages/index.tsx: -------------------------------------------------------------------------------- 1 | /* eslint-disable @next/next/no-img-element */ 2 | import type { NextPage } from 'next' 3 | import absoluteUrl from 'next-absolute-url' 4 | import Head from 'next/head' 5 | import Link from 'next/link' 6 | import { useEffect } from 'react' 7 | import Logo from '../components/logo' 8 | import { Link as LinkType } from '../hooks-generated' 9 | const parse = require('html-react-parser') 10 | 11 | const Home = ({ links }: { links: LinkType[]}) => { 12 | if(!links || links.length === 0) 13 | return ( 14 |
15 | 16 | Singlelink under construction 17 | 18 | 19 | 20 | 21 |
22 |
23 |

Under construction

24 |

This Singlelink page is currently under construction. Be sure to check back soon!

25 | 26 | 27 | 28 |
29 |
Copyright ©{new Date().getFullYear()} Neutron Creative Inc. All rights reserved.
30 | 31 |
32 | ) 33 | return ( 34 | <> 35 | 36 | {process.env.META_TITLE} 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 |
53 | {[...links].map(link => { 54 | if(link?.type === 'text') 55 | return () 59 | if(link?.type === 'vanilla') 60 | return ({link?.label}) 61 | if(link?.type === 'avatar') 62 | return () 65 | if(link?.type === 'youtube') 66 | return () 69 | if(link?.type === 'image') 70 | return ({link.label) 71 | if(link?.type === 'html') 72 | return () 73 | })} 74 | {process.env.BRANDING &&
Build your free micro-site in seconds with Singlelink
} 75 |
76 | 77 | ) 78 | } 79 | 80 | export async function getServerSideProps({ req }: { req: any}) { 81 | const { origin } = absoluteUrl(req) 82 | const res = await fetch(`${origin}/api/graphql`, { 83 | "headers": { 84 | "accept": "application/json", 85 | "content-type": "application/json", 86 | }, 87 | "body": "{\"operationName\":\"listLinks\",\"variables\":{},\"query\":\"query listLinks {\\n listLinks {\\n id\\n label\\n content\\n type\\n position\\n __typename\\n }\\n}\\n\"}", 88 | "method": "POST" 89 | }) 90 | const data = await res.json() 91 | const links: LinkType[] = data.data.listLinks 92 | if(req.url.substr(req.url.length-9) != 'demo=true') { 93 | // Create view if viewed by guest 94 | await fetch(`${origin}/api/graphql`, { 95 | "headers": { 96 | "accept": "application/json", 97 | "accept-language": "en-US,en;q=0.9", 98 | "content-type": "application/json", 99 | "sec-ch-ua": "\" Not A;Brand\";v=\"99\", \"Chromium\";v=\"98\", \"Google Chrome\";v=\"98\"", 100 | "sec-ch-ua-mobile": "?0", 101 | "sec-ch-ua-platform": "\"Windows\"", 102 | "sec-fetch-dest": "empty", 103 | "sec-fetch-mode": "cors", 104 | "sec-fetch-site": "same-origin", 105 | "Referer": "http://localhost:3000/", 106 | "Referrer-Policy": "strict-origin-when-cross-origin" 107 | }, 108 | "body": "{\"operationName\":\"createEvent\",\"variables\":{\"type\":\"view\"},\"query\":\"mutation createEvent($type: EVENT_TYPE) {\\n createEvent(type: $type) {\\n id\\n type\\n created_at\\n __typename\\n }\\n}\\n\"}", 109 | "method": "POST" 110 | }); 111 | } 112 | return { props: { links } } 113 | 114 | } 115 | 116 | export default Home 117 | -------------------------------------------------------------------------------- /components/logo.tsx: -------------------------------------------------------------------------------- 1 | const Logo = () => ( 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | ) 55 | 56 | export default Logo -------------------------------------------------------------------------------- /components/dashboard.tsx: -------------------------------------------------------------------------------- 1 | import Link from "next/link"; 2 | import { useEffect, useState } from "react"; 3 | import LogoLong from "./logo-long"; 4 | 5 | const Dashboard = ({ children }: { children: any}) => { 6 | const [domain, setDomain] = useState() 7 | 8 | const share = () => { 9 | navigator.clipboard.writeText(domain ?? '#') 10 | alert('URL copied to your clipboard!') 11 | } 12 | 13 | useEffect(() => { 14 | if(location.hostname === 'localhost') return setDomain(`http://${window.location.host}`) 15 | setDomain(`https://${window.location.host}`) 16 | }, []) 17 | 18 | return ( 19 |
20 |
21 |
22 |
23 |
24 |
v4.1.0
25 |
26 |
    27 | 28 |
    29 | 30 | Links 31 |
    32 | 33 | 34 |
    35 | 36 | Analytics 37 |
    38 | 39 | {/* 40 | 41 |
    42 | Settings 43 |
    44 | 45 | */} 46 | 47 |
    48 | Logout 49 |
    50 | 51 | 52 |
53 | 54 |
55 | {/* TODO: Update link with Discount, and check if BRANDING is true before displaying */} 56 | {/* 57 | 58 | 59 | Sign up for Singlelink Cloud for only $5/mo! 60 | 61 | 62 | */} 63 |
64 |
65 | {children} 66 |
67 |
68 |
69 |
70 | 71 |
Page preview:
72 |
73 | 76 |
77 |
78 |
79 | {domain && } 80 |
81 |
82 |
83 | Share your Singlelink: 84 | {domain} 85 | share()} className="w-4 h-4 cursor-pointer" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"> 86 |
87 |
88 |
89 | ) 90 | } 91 | 92 | export default Dashboard -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | Singlelink logo 4 | 5 |

6 | 7 |

8 | Singlelink is the open-source Linktree alternative. 9 |

10 |

11 | 12 | Build & lint 13 | 14 | 15 | Version 16 | 17 | 18 | License 19 | 20 | 21 | Users 22 | 23 | 24 | 25 | 26 |

27 | 28 |

29 | 30 | Twitter Follow 31 | 33 | 34 | 35 |

36 | 37 |

38 | Getting started • 39 | Local development • 40 | Production deployment • 41 | Credits 42 |

43 | 44 |

Getting started

45 | 46 | The easiest way to get started is to deploy your [Singlelink](https://singlelink.co) site with [Railway](https://railway.app). You can get started with one-click using the button below and build up to three Singlelink pages, each with custom domains, 100% free, thanks to their $5/mo credit system. 47 | 48 | [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template/R7HMcu) 49 | 50 | We also recommend connecting [Vercel](https://vercel.com) and [Planetscale](https://planetscale.com) for a free self-hosted Singlelink environment. 51 | 52 |

Local development

53 | 54 | Singlelink is a [NodeJS](#) project built on [Next.js](https://nodejs.org/en/), [GraphQL](https://graphql.org/) (served via [Apollo Server](https://www.apollographql.com/)), and [MySQL](https://www.MySQL.org/). 55 | 56 | If you haven't already, you'll need to install NodeJS and MySQL before being able to host or work on Singelink. 57 | - [NodeJS installation guide](https://nodejs.dev/learn/how-to-install-nodejs) 58 | - To install MySQL with Docker, run `npm run db:boot` from the project root. 59 | 60 | Once you've installed NodeJS & MySQL, you can download Singlelink locally with: 61 | ```bash 62 | git clone https://github.com/Neutron-Creative/Singlelink.git;cd Singlelink; 63 | ``` 64 | 65 | Before you start, you'll need to configure your environment by copying the .env template: 66 | ``` 67 | cp .env.template .env 68 | ``` 69 | 70 | Then, set the following **mandatory** environment variables to your preferences: 71 | - `DB_URL`: Optionally, override the remaining DB ENV variables with an all-in-one connection URL 72 | - `DB_DATABASE`: The name of the MySQL database you'll connect to (ex: railway) 73 | - `DB_PORT`: The port for the MySQL database you'll connect to (ex: 3306) 74 | - `DB_HOST`: The host url for your MySQL database (ex: containers-us-east-13.railway.app) 75 | - `DB_USER`: The username for your MySQL user (ex: root) 76 | - `DB_PASSWORD`: The password for your MySQL user 77 | - `SECRET`: The secret used to sign and validate JWTs during authentication 78 | - `PASSWORD`: The password you'll use to login and manage your Singlelink 79 | 80 | Optionally, set the following variables to customize your site: 81 | - `META_TITLE`: The title for your site, seen in Google Search results 82 | - `META_DESC`: The description for your site, seen in Google Search results 83 | - `META_IMG`: The OG image for your site, seen when sharing your site on social media. 84 | - `BRANDING`: A boolean that enables/disables Singlelink branding on your site & dashboard 85 | 86 | Next, install your NPM dependencies using `--ignore-scripts`: 87 | ```bash 88 | npm i --ignore-scripts 89 | ``` 90 | 91 | After, you can run the DB migration script to initialize your DB: 92 | ```bash 93 | npm run db:migrate 94 | ``` 95 | *You'll need to run `npm run db:migrate` again everytime you pull changes. It can't hurt to run a migration, but it can break things if you don't.*

96 | 97 | Finally, you can start your development environment by running: 98 | ```bash 99 | npm run dev 100 | ``` 101 | 102 | Open [http://localhost:3000](http://localhost:3000) with your browser to view your new Singlelink, and [http://localhost:3000/login](http://localhost:3000/login) to login and add your first link. 103 | 104 |

Production deployment

105 | 106 | You can [deploy Singlelink in one-click here with Railway](https://railway.app/new/template?template=https%3A%2F%2Fgithub.com%2FNeutron-Creative%2FSinglelink&plugins=MySQL&envs=SECRET%2CPASSWORD%2CMETA_TITLE%2CMETA_DESC%2CMETA_IMG&optionalEnvs=META_TITLE%2CMETA_DESC%2CMETA_IMG&SECRETDesc=The+secret+used+when+signing+JWTs.&PASSWORDDesc=The+password+you%27ll+use+to+login+to+your+Singlelink+dashboard.&META_TITLEDesc=Your+page+%26+meta+title%2C+seen+in+Google+search+results&META_DESCDesc=Your+page+description+seen+in+Google+Search+results.&META_IMGDesc=The+OG+image+thumbnail+shown+when+sharing+your+Singlelink+on+social+media.&referralCode=singlelink). At this time, they are the only provider we maintain & gurantee support for. 107 | 108 | ### Need to host elsewhere? 109 | #### Platform as a service hosts are recommended due to ease of installation (ex: Heroku, DigitalOcean App Platform , etc.) 110 | We don't offer official support yet, but you can host Singlelink with any VPS, provided you can install and run both Node.JS & MySQL. Singlelink will need one MySQL database, and one NodeJS instance capable of running Next.JS at run-time/SSR. 111 |

112 |

113 | Looking for cloud hosting with premium support? 114 |
115 | Consider checking out Singlelink Cloud, with plans available soon starting at just $8/month.
116 |

117 | 118 |

Credits

119 | 120 | Singlelink was built by the following team full-time from August 2020-2021 our mission to to *open-source the world* at [Neutron Creative](https://neutroncreative.com). 121 |

122 |
    123 |
  • Jim Bisenius (Co-founder & former CEO, @jim_bisenius)
  • 124 |
  • Navid Kabir (Co-founder & former CTO, @navidk0)
  • 125 |
  • Andrew Boyle (Co-founder & former CMO)
  • 126 |

127 | 128 | Today, Singlelink is maintained soley by me, Jim Bisenius on nights & weekends. If you'd like to assist in my development efforts, I'd love your help. Please [join our Discord](https://discord.gg/DDGnXCcgsu) or [create a pull request](https://github.com/Neutron-Creative/Singlelink/pulls)! 129 | -------------------------------------------------------------------------------- /logo-long.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | -------------------------------------------------------------------------------- /components/logo-long.tsx: -------------------------------------------------------------------------------- 1 | const LogoLong = () => ( 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | ) 62 | 63 | export default LogoLong -------------------------------------------------------------------------------- /hooks-generated/index.ts: -------------------------------------------------------------------------------- 1 | import { gql } from '@apollo/client'; 2 | import * as Apollo from '@apollo/client'; 3 | export type Maybe = T | null; 4 | export type Exact = { [K in keyof T]: T[K] }; 5 | export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; 6 | export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; 7 | const defaultOptions = {} as const; 8 | /** All built-in and custom scalars, mapped to their actual values */ 9 | export type Scalars = { 10 | ID: string; 11 | String: string; 12 | Boolean: boolean; 13 | Int: number; 14 | Float: number; 15 | }; 16 | 17 | export enum Event_Type { 18 | Click = 'click', 19 | View = 'view' 20 | } 21 | 22 | export type Event = { 23 | __typename?: 'Event'; 24 | created_at: Scalars['String']; 25 | id: Scalars['Int']; 26 | link_id: Scalars['Int']; 27 | type: Event_Type; 28 | }; 29 | 30 | export type Link = { 31 | __typename?: 'Link'; 32 | content?: Maybe; 33 | id: Scalars['Int']; 34 | label?: Maybe; 35 | position: Scalars['Int']; 36 | type: Scalars['String']; 37 | }; 38 | 39 | export type Mutation = { 40 | __typename?: 'Mutation'; 41 | createEvent?: Maybe; 42 | createLink?: Maybe; 43 | deleteLinkById?: Maybe; 44 | login?: Maybe; 45 | reorderLink?: Maybe>>; 46 | updateLinkById?: Maybe; 47 | verify?: Maybe; 48 | }; 49 | 50 | 51 | export type MutationCreateEventArgs = { 52 | type?: Maybe; 53 | }; 54 | 55 | 56 | export type MutationCreateLinkArgs = { 57 | content?: Maybe; 58 | label?: Maybe; 59 | type: Scalars['String']; 60 | }; 61 | 62 | 63 | export type MutationDeleteLinkByIdArgs = { 64 | id: Scalars['Int']; 65 | }; 66 | 67 | 68 | export type MutationLoginArgs = { 69 | password?: Maybe; 70 | }; 71 | 72 | 73 | export type MutationReorderLinkArgs = { 74 | id: Scalars['Int']; 75 | newIndex: Scalars['Int']; 76 | oldIndex: Scalars['Int']; 77 | }; 78 | 79 | 80 | export type MutationUpdateLinkByIdArgs = { 81 | content?: Maybe; 82 | id: Scalars['Int']; 83 | label?: Maybe; 84 | position: Scalars['Int']; 85 | type: Scalars['String']; 86 | }; 87 | 88 | 89 | export type MutationVerifyArgs = { 90 | jwt?: Maybe; 91 | }; 92 | 93 | export type Overview = { 94 | __typename?: 'Overview'; 95 | clicks: Scalars['Int']; 96 | date: Scalars['String']; 97 | views: Scalars['Int']; 98 | }; 99 | 100 | export type Query = { 101 | __typename?: 'Query'; 102 | fetchOverview?: Maybe>>; 103 | findLinkById?: Maybe; 104 | hello?: Maybe; 105 | listLinks?: Maybe>>; 106 | }; 107 | 108 | 109 | export type QueryFindLinkByIdArgs = { 110 | id: Scalars['Int']; 111 | }; 112 | 113 | export type LoginMutationVariables = Exact<{ 114 | password: Scalars['String']; 115 | }>; 116 | 117 | 118 | export type LoginMutation = ( 119 | { __typename?: 'Mutation' } 120 | & Pick 121 | ); 122 | 123 | export type VerifyMutationVariables = Exact<{ 124 | jwt: Scalars['String']; 125 | }>; 126 | 127 | 128 | export type VerifyMutation = ( 129 | { __typename?: 'Mutation' } 130 | & Pick 131 | ); 132 | 133 | export type CreateLinkMutationVariables = Exact<{ 134 | label?: Maybe; 135 | content?: Maybe; 136 | type: Scalars['String']; 137 | }>; 138 | 139 | 140 | export type CreateLinkMutation = ( 141 | { __typename?: 'Mutation' } 142 | & { createLink?: Maybe<( 143 | { __typename?: 'Link' } 144 | & Pick 145 | )> } 146 | ); 147 | 148 | export type UpdateLinkByIdMutationVariables = Exact<{ 149 | label?: Maybe; 150 | content?: Maybe; 151 | id: Scalars['Int']; 152 | position: Scalars['Int']; 153 | type: Scalars['String']; 154 | }>; 155 | 156 | 157 | export type UpdateLinkByIdMutation = ( 158 | { __typename?: 'Mutation' } 159 | & { updateLinkById?: Maybe<( 160 | { __typename?: 'Link' } 161 | & Pick 162 | )> } 163 | ); 164 | 165 | export type DeleteLinkByIdMutationVariables = Exact<{ 166 | id: Scalars['Int']; 167 | }>; 168 | 169 | 170 | export type DeleteLinkByIdMutation = ( 171 | { __typename?: 'Mutation' } 172 | & { deleteLinkById?: Maybe<( 173 | { __typename?: 'Link' } 174 | & Pick 175 | )> } 176 | ); 177 | 178 | export type ReorderLinkMutationVariables = Exact<{ 179 | id: Scalars['Int']; 180 | newIndex: Scalars['Int']; 181 | oldIndex: Scalars['Int']; 182 | }>; 183 | 184 | 185 | export type ReorderLinkMutation = ( 186 | { __typename?: 'Mutation' } 187 | & { reorderLink?: Maybe 190 | )>>> } 191 | ); 192 | 193 | export type CreateEventMutationVariables = Exact<{ 194 | type?: Maybe; 195 | }>; 196 | 197 | 198 | export type CreateEventMutation = ( 199 | { __typename?: 'Mutation' } 200 | & { createEvent?: Maybe<( 201 | { __typename?: 'Event' } 202 | & Pick 203 | )> } 204 | ); 205 | 206 | export type HelloQueryVariables = Exact<{ [key: string]: never; }>; 207 | 208 | 209 | export type HelloQuery = ( 210 | { __typename?: 'Query' } 211 | & Pick 212 | ); 213 | 214 | export type ListLinksQueryVariables = Exact<{ [key: string]: never; }>; 215 | 216 | 217 | export type ListLinksQuery = ( 218 | { __typename?: 'Query' } 219 | & { listLinks?: Maybe 222 | )>>> } 223 | ); 224 | 225 | export type FindLinkByIdQueryVariables = Exact<{ 226 | id: Scalars['Int']; 227 | }>; 228 | 229 | 230 | export type FindLinkByIdQuery = ( 231 | { __typename?: 'Query' } 232 | & { findLinkById?: Maybe<( 233 | { __typename?: 'Link' } 234 | & Pick 235 | )> } 236 | ); 237 | 238 | export type FetchOverviewQueryVariables = Exact<{ [key: string]: never; }>; 239 | 240 | 241 | export type FetchOverviewQuery = ( 242 | { __typename?: 'Query' } 243 | & { fetchOverview?: Maybe 246 | )>>> } 247 | ); 248 | 249 | 250 | export const LoginDocument = gql` 251 | mutation login($password: String!) { 252 | login(password: $password) 253 | } 254 | `; 255 | export type LoginMutationFn = Apollo.MutationFunction; 256 | 257 | /** 258 | * __useLoginMutation__ 259 | * 260 | * To run a mutation, you first call `useLoginMutation` within a React component and pass it any options that fit your needs. 261 | * When your component renders, `useLoginMutation` returns a tuple that includes: 262 | * - A mutate function that you can call at any time to execute the mutation 263 | * - An object with fields that represent the current status of the mutation's execution 264 | * 265 | * @param baseOptions options that will be passed into the mutation, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options-2; 266 | * 267 | * @example 268 | * const [loginMutation, { data, loading, error }] = useLoginMutation({ 269 | * variables: { 270 | * password: // value for 'password' 271 | * }, 272 | * }); 273 | */ 274 | export function useLoginMutation(baseOptions?: Apollo.MutationHookOptions) { 275 | const options = {...defaultOptions, ...baseOptions} 276 | return Apollo.useMutation(LoginDocument, options); 277 | } 278 | export type LoginMutationHookResult = ReturnType; 279 | export type LoginMutationResult = Apollo.MutationResult; 280 | export type LoginMutationOptions = Apollo.BaseMutationOptions; 281 | export const VerifyDocument = gql` 282 | mutation verify($jwt: String!) { 283 | verify(jwt: $jwt) 284 | } 285 | `; 286 | export type VerifyMutationFn = Apollo.MutationFunction; 287 | 288 | /** 289 | * __useVerifyMutation__ 290 | * 291 | * To run a mutation, you first call `useVerifyMutation` within a React component and pass it any options that fit your needs. 292 | * When your component renders, `useVerifyMutation` returns a tuple that includes: 293 | * - A mutate function that you can call at any time to execute the mutation 294 | * - An object with fields that represent the current status of the mutation's execution 295 | * 296 | * @param baseOptions options that will be passed into the mutation, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options-2; 297 | * 298 | * @example 299 | * const [verifyMutation, { data, loading, error }] = useVerifyMutation({ 300 | * variables: { 301 | * jwt: // value for 'jwt' 302 | * }, 303 | * }); 304 | */ 305 | export function useVerifyMutation(baseOptions?: Apollo.MutationHookOptions) { 306 | const options = {...defaultOptions, ...baseOptions} 307 | return Apollo.useMutation(VerifyDocument, options); 308 | } 309 | export type VerifyMutationHookResult = ReturnType; 310 | export type VerifyMutationResult = Apollo.MutationResult; 311 | export type VerifyMutationOptions = Apollo.BaseMutationOptions; 312 | export const CreateLinkDocument = gql` 313 | mutation createLink($label: String, $content: String, $type: String!) { 314 | createLink(label: $label, content: $content, type: $type) { 315 | id 316 | label 317 | content 318 | type 319 | position 320 | } 321 | } 322 | `; 323 | export type CreateLinkMutationFn = Apollo.MutationFunction; 324 | 325 | /** 326 | * __useCreateLinkMutation__ 327 | * 328 | * To run a mutation, you first call `useCreateLinkMutation` within a React component and pass it any options that fit your needs. 329 | * When your component renders, `useCreateLinkMutation` returns a tuple that includes: 330 | * - A mutate function that you can call at any time to execute the mutation 331 | * - An object with fields that represent the current status of the mutation's execution 332 | * 333 | * @param baseOptions options that will be passed into the mutation, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options-2; 334 | * 335 | * @example 336 | * const [createLinkMutation, { data, loading, error }] = useCreateLinkMutation({ 337 | * variables: { 338 | * label: // value for 'label' 339 | * content: // value for 'content' 340 | * type: // value for 'type' 341 | * }, 342 | * }); 343 | */ 344 | export function useCreateLinkMutation(baseOptions?: Apollo.MutationHookOptions) { 345 | const options = {...defaultOptions, ...baseOptions} 346 | return Apollo.useMutation(CreateLinkDocument, options); 347 | } 348 | export type CreateLinkMutationHookResult = ReturnType; 349 | export type CreateLinkMutationResult = Apollo.MutationResult; 350 | export type CreateLinkMutationOptions = Apollo.BaseMutationOptions; 351 | export const UpdateLinkByIdDocument = gql` 352 | mutation updateLinkById($label: String, $content: String, $id: Int!, $position: Int!, $type: String!) { 353 | updateLinkById( 354 | label: $label 355 | content: $content 356 | id: $id 357 | position: $position 358 | type: $type 359 | ) { 360 | id 361 | label 362 | content 363 | type 364 | position 365 | } 366 | } 367 | `; 368 | export type UpdateLinkByIdMutationFn = Apollo.MutationFunction; 369 | 370 | /** 371 | * __useUpdateLinkByIdMutation__ 372 | * 373 | * To run a mutation, you first call `useUpdateLinkByIdMutation` within a React component and pass it any options that fit your needs. 374 | * When your component renders, `useUpdateLinkByIdMutation` returns a tuple that includes: 375 | * - A mutate function that you can call at any time to execute the mutation 376 | * - An object with fields that represent the current status of the mutation's execution 377 | * 378 | * @param baseOptions options that will be passed into the mutation, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options-2; 379 | * 380 | * @example 381 | * const [updateLinkByIdMutation, { data, loading, error }] = useUpdateLinkByIdMutation({ 382 | * variables: { 383 | * label: // value for 'label' 384 | * content: // value for 'content' 385 | * id: // value for 'id' 386 | * position: // value for 'position' 387 | * type: // value for 'type' 388 | * }, 389 | * }); 390 | */ 391 | export function useUpdateLinkByIdMutation(baseOptions?: Apollo.MutationHookOptions) { 392 | const options = {...defaultOptions, ...baseOptions} 393 | return Apollo.useMutation(UpdateLinkByIdDocument, options); 394 | } 395 | export type UpdateLinkByIdMutationHookResult = ReturnType; 396 | export type UpdateLinkByIdMutationResult = Apollo.MutationResult; 397 | export type UpdateLinkByIdMutationOptions = Apollo.BaseMutationOptions; 398 | export const DeleteLinkByIdDocument = gql` 399 | mutation deleteLinkById($id: Int!) { 400 | deleteLinkById(id: $id) { 401 | id 402 | label 403 | content 404 | type 405 | position 406 | } 407 | } 408 | `; 409 | export type DeleteLinkByIdMutationFn = Apollo.MutationFunction; 410 | 411 | /** 412 | * __useDeleteLinkByIdMutation__ 413 | * 414 | * To run a mutation, you first call `useDeleteLinkByIdMutation` within a React component and pass it any options that fit your needs. 415 | * When your component renders, `useDeleteLinkByIdMutation` returns a tuple that includes: 416 | * - A mutate function that you can call at any time to execute the mutation 417 | * - An object with fields that represent the current status of the mutation's execution 418 | * 419 | * @param baseOptions options that will be passed into the mutation, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options-2; 420 | * 421 | * @example 422 | * const [deleteLinkByIdMutation, { data, loading, error }] = useDeleteLinkByIdMutation({ 423 | * variables: { 424 | * id: // value for 'id' 425 | * }, 426 | * }); 427 | */ 428 | export function useDeleteLinkByIdMutation(baseOptions?: Apollo.MutationHookOptions) { 429 | const options = {...defaultOptions, ...baseOptions} 430 | return Apollo.useMutation(DeleteLinkByIdDocument, options); 431 | } 432 | export type DeleteLinkByIdMutationHookResult = ReturnType; 433 | export type DeleteLinkByIdMutationResult = Apollo.MutationResult; 434 | export type DeleteLinkByIdMutationOptions = Apollo.BaseMutationOptions; 435 | export const ReorderLinkDocument = gql` 436 | mutation reorderLink($id: Int!, $newIndex: Int!, $oldIndex: Int!) { 437 | reorderLink(id: $id, newIndex: $newIndex, oldIndex: $oldIndex) { 438 | label 439 | content 440 | id 441 | position 442 | type 443 | } 444 | } 445 | `; 446 | export type ReorderLinkMutationFn = Apollo.MutationFunction; 447 | 448 | /** 449 | * __useReorderLinkMutation__ 450 | * 451 | * To run a mutation, you first call `useReorderLinkMutation` within a React component and pass it any options that fit your needs. 452 | * When your component renders, `useReorderLinkMutation` returns a tuple that includes: 453 | * - A mutate function that you can call at any time to execute the mutation 454 | * - An object with fields that represent the current status of the mutation's execution 455 | * 456 | * @param baseOptions options that will be passed into the mutation, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options-2; 457 | * 458 | * @example 459 | * const [reorderLinkMutation, { data, loading, error }] = useReorderLinkMutation({ 460 | * variables: { 461 | * id: // value for 'id' 462 | * newIndex: // value for 'newIndex' 463 | * oldIndex: // value for 'oldIndex' 464 | * }, 465 | * }); 466 | */ 467 | export function useReorderLinkMutation(baseOptions?: Apollo.MutationHookOptions) { 468 | const options = {...defaultOptions, ...baseOptions} 469 | return Apollo.useMutation(ReorderLinkDocument, options); 470 | } 471 | export type ReorderLinkMutationHookResult = ReturnType; 472 | export type ReorderLinkMutationResult = Apollo.MutationResult; 473 | export type ReorderLinkMutationOptions = Apollo.BaseMutationOptions; 474 | export const CreateEventDocument = gql` 475 | mutation createEvent($type: EVENT_TYPE) { 476 | createEvent(type: $type) { 477 | id 478 | type 479 | created_at 480 | } 481 | } 482 | `; 483 | export type CreateEventMutationFn = Apollo.MutationFunction; 484 | 485 | /** 486 | * __useCreateEventMutation__ 487 | * 488 | * To run a mutation, you first call `useCreateEventMutation` within a React component and pass it any options that fit your needs. 489 | * When your component renders, `useCreateEventMutation` returns a tuple that includes: 490 | * - A mutate function that you can call at any time to execute the mutation 491 | * - An object with fields that represent the current status of the mutation's execution 492 | * 493 | * @param baseOptions options that will be passed into the mutation, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options-2; 494 | * 495 | * @example 496 | * const [createEventMutation, { data, loading, error }] = useCreateEventMutation({ 497 | * variables: { 498 | * type: // value for 'type' 499 | * }, 500 | * }); 501 | */ 502 | export function useCreateEventMutation(baseOptions?: Apollo.MutationHookOptions) { 503 | const options = {...defaultOptions, ...baseOptions} 504 | return Apollo.useMutation(CreateEventDocument, options); 505 | } 506 | export type CreateEventMutationHookResult = ReturnType; 507 | export type CreateEventMutationResult = Apollo.MutationResult; 508 | export type CreateEventMutationOptions = Apollo.BaseMutationOptions; 509 | export const HelloDocument = gql` 510 | query hello { 511 | hello 512 | } 513 | `; 514 | 515 | /** 516 | * __useHelloQuery__ 517 | * 518 | * To run a query within a React component, call `useHelloQuery` and pass it any options that fit your needs. 519 | * When your component renders, `useHelloQuery` returns an object from Apollo Client that contains loading, error, and data properties 520 | * you can use to render your UI. 521 | * 522 | * @param baseOptions options that will be passed into the query, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options; 523 | * 524 | * @example 525 | * const { data, loading, error } = useHelloQuery({ 526 | * variables: { 527 | * }, 528 | * }); 529 | */ 530 | export function useHelloQuery(baseOptions?: Apollo.QueryHookOptions) { 531 | const options = {...defaultOptions, ...baseOptions} 532 | return Apollo.useQuery(HelloDocument, options); 533 | } 534 | export function useHelloLazyQuery(baseOptions?: Apollo.LazyQueryHookOptions) { 535 | const options = {...defaultOptions, ...baseOptions} 536 | return Apollo.useLazyQuery(HelloDocument, options); 537 | } 538 | export type HelloQueryHookResult = ReturnType; 539 | export type HelloLazyQueryHookResult = ReturnType; 540 | export type HelloQueryResult = Apollo.QueryResult; 541 | export const ListLinksDocument = gql` 542 | query listLinks { 543 | listLinks { 544 | id 545 | label 546 | content 547 | type 548 | position 549 | } 550 | } 551 | `; 552 | 553 | /** 554 | * __useListLinksQuery__ 555 | * 556 | * To run a query within a React component, call `useListLinksQuery` and pass it any options that fit your needs. 557 | * When your component renders, `useListLinksQuery` returns an object from Apollo Client that contains loading, error, and data properties 558 | * you can use to render your UI. 559 | * 560 | * @param baseOptions options that will be passed into the query, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options; 561 | * 562 | * @example 563 | * const { data, loading, error } = useListLinksQuery({ 564 | * variables: { 565 | * }, 566 | * }); 567 | */ 568 | export function useListLinksQuery(baseOptions?: Apollo.QueryHookOptions) { 569 | const options = {...defaultOptions, ...baseOptions} 570 | return Apollo.useQuery(ListLinksDocument, options); 571 | } 572 | export function useListLinksLazyQuery(baseOptions?: Apollo.LazyQueryHookOptions) { 573 | const options = {...defaultOptions, ...baseOptions} 574 | return Apollo.useLazyQuery(ListLinksDocument, options); 575 | } 576 | export type ListLinksQueryHookResult = ReturnType; 577 | export type ListLinksLazyQueryHookResult = ReturnType; 578 | export type ListLinksQueryResult = Apollo.QueryResult; 579 | export const FindLinkByIdDocument = gql` 580 | query findLinkById($id: Int!) { 581 | findLinkById(id: $id) { 582 | id 583 | label 584 | content 585 | type 586 | position 587 | } 588 | } 589 | `; 590 | 591 | /** 592 | * __useFindLinkByIdQuery__ 593 | * 594 | * To run a query within a React component, call `useFindLinkByIdQuery` and pass it any options that fit your needs. 595 | * When your component renders, `useFindLinkByIdQuery` returns an object from Apollo Client that contains loading, error, and data properties 596 | * you can use to render your UI. 597 | * 598 | * @param baseOptions options that will be passed into the query, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options; 599 | * 600 | * @example 601 | * const { data, loading, error } = useFindLinkByIdQuery({ 602 | * variables: { 603 | * id: // value for 'id' 604 | * }, 605 | * }); 606 | */ 607 | export function useFindLinkByIdQuery(baseOptions: Apollo.QueryHookOptions) { 608 | const options = {...defaultOptions, ...baseOptions} 609 | return Apollo.useQuery(FindLinkByIdDocument, options); 610 | } 611 | export function useFindLinkByIdLazyQuery(baseOptions?: Apollo.LazyQueryHookOptions) { 612 | const options = {...defaultOptions, ...baseOptions} 613 | return Apollo.useLazyQuery(FindLinkByIdDocument, options); 614 | } 615 | export type FindLinkByIdQueryHookResult = ReturnType; 616 | export type FindLinkByIdLazyQueryHookResult = ReturnType; 617 | export type FindLinkByIdQueryResult = Apollo.QueryResult; 618 | export const FetchOverviewDocument = gql` 619 | query fetchOverview { 620 | fetchOverview { 621 | views 622 | clicks 623 | date 624 | } 625 | } 626 | `; 627 | 628 | /** 629 | * __useFetchOverviewQuery__ 630 | * 631 | * To run a query within a React component, call `useFetchOverviewQuery` and pass it any options that fit your needs. 632 | * When your component renders, `useFetchOverviewQuery` returns an object from Apollo Client that contains loading, error, and data properties 633 | * you can use to render your UI. 634 | * 635 | * @param baseOptions options that will be passed into the query, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options; 636 | * 637 | * @example 638 | * const { data, loading, error } = useFetchOverviewQuery({ 639 | * variables: { 640 | * }, 641 | * }); 642 | */ 643 | export function useFetchOverviewQuery(baseOptions?: Apollo.QueryHookOptions) { 644 | const options = {...defaultOptions, ...baseOptions} 645 | return Apollo.useQuery(FetchOverviewDocument, options); 646 | } 647 | export function useFetchOverviewLazyQuery(baseOptions?: Apollo.LazyQueryHookOptions) { 648 | const options = {...defaultOptions, ...baseOptions} 649 | return Apollo.useLazyQuery(FetchOverviewDocument, options); 650 | } 651 | export type FetchOverviewQueryHookResult = ReturnType; 652 | export type FetchOverviewLazyQueryHookResult = ReturnType; 653 | export type FetchOverviewQueryResult = Apollo.QueryResult; -------------------------------------------------------------------------------- /license.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Neutron Capture Copyright (C) 2020 Neutron Creative Inc. 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------