https://github.com/aretecode/konsilos
https://konsilos.com/welcome re-imagined
https://github.com/aretecode/konsilos
Last synced: 5 months ago
JSON representation
https://konsilos.com/welcome re-imagined
- Host: GitHub
- URL: https://github.com/aretecode/konsilos
- Owner: aretecode
- License: mit
- Created: 2019-09-20T01:02:26.000Z (over 6 years ago)
- Default Branch: merge
- Last Pushed: 2022-12-11T06:41:56.000Z (about 3 years ago)
- Last Synced: 2025-02-25T08:16:23.477Z (11 months ago)
- Language: TypeScript
- Homepage: https://konsilos.now.sh
- Size: 6.11 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Konsilos
**A non-rofit organization.**
We created this with good intentions, to scratch our itch, hoping this also would benefit people all over the world.
- site & app: [https://konsilos.now.sh](https://konsilos.now.sh)
- storybook: [https://konsilos.now.sh/ui/](https://konsilos.now.sh/ui/)
- graphql playground: [https://konsilos.now.sh/graphql/](https://konsilos.now.sh/ui/) (_see the ["everything" query](./src/graphql/everythingQuery.graphql.ts)_)
- [TODOS](./TODO.md)
# features
- deployment to serverless aws lamda (_with ephemeral urls on every pr, and docker setup for custom deploys_)
- react SPA (_using nextjs, also with service worker / offline support and lighthouse compliance_)
- oauth on subscribe button, with a SAAS authentication microservice (_using auth2_)
- storybook for ui development velocity (_aslso available on deployment_)
- graphql as a micro api connected to airtable (_aslso available on deployment_)
- images via cdn with webp format (_using sirv_)
- svg images (_flags, icons, logo_)
- semantic html, seo including card previews minimal styles (_using styled-components_)
- custom responsive css devices
- typescript with all types passing, eslint, prettier, stylelint, editorconfig
- unit testing with storybook snapshots, react-testing-library
- i18n translation
- app domain features
- family: add & view family (_using react hooks, graphql in progress_)
- advice: add & view advice (_using react hooks, graphql in progress_)
## how to run
1. use [vscode](https://code.visualstudio.com/) (_for the best experience_)
1. use **nodejs** `12.10.0` (_or **latest**_)
2. `npm i` or `yarn` (_install dependencies_)
3. go to [env.js](./env.js) file to set your keys
4. run app or storybook
- `yarn dev` (_app_)
- `yarn dev:server` (_for using auth0 locally via custom next server_)
- `yarn dev:storybook` (_storybook_)
## folder structure
- `/pages` contains pages, and the nextjs specific `_app` & `_document`
- `/server` nextjs server using expressjs, added so we can handle route for auth0/user-signin
- `/src` all non `page` code
- `/components` react components. each component _SHOULD_ have:
- `NAME.test.tsx` jest tests
- `NAME.story.tsx`
- `/features` react components same as ^, but with domain knowledge
- `/graphql` graphql specific code (_apollo, queries, mutations_)
- `/utils` utils that can be moved to separate packages
- `AppStyles` styled components global styles
- `AppContext` provided by `pages/_app` via nextjs, available to all components (_things like `url` of the page_)
- `typings` typescript definitions
## more scripts
- see [package.json](./package.json)
- `yarn test` (_jest_)
- `yarn lint` (_lint_)
## more information
- stack:
- [nextjs](https://nextjs.org/)
- [typescript](https://www.typescriptlang.org)
- [react](https://reactjs.org)
- [styled-components](https://www.styled-components.com)
- [apollo graphql](https://www.apollographql.com/)
- tool stack:
- [jest unit tests](https://jestjs.io)
- [storybook](https://storybook.js.org)
- [zeit now](https://zeit.co/)
- [travis ci](https://travis-ci.org/)
- [makefile](https://gist.github.com/isaacs/62a2d1825d04437c6f08)
- [yarn](https://yarnpkg.com/lang/en/)
- [babeljs](https://babeljs.io)
- [docker](https://www.docker.com)
- formatting & quality check tools:
- [prettier](https://prettier.io/)
- [eslint](https://eslint.org)
- [stylelint](https://github.com/stylelint/stylelint)
- [dangerjs](https://github.com/danger/danger/blob/master/Dangerfile)
- [editorconfig](https://editorconfig.org)