first commit

.commitlintrc

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@commitlint/config-conventional"
+  ]
+}

.env.example

@@ -0,0 +1,15 @@
+HASURA_GRAPHQL_ADMIN_SECRET
+HASURA_GRAPHQL_METADATA_DATABASE_URL
+HASURA_GRAPHQL_JWT_SECRET
+ALGOLIA_ADMIN_API_KEY
+ALGOLIA_APP_ID
+ALGOLIA_INDEX
+HASURA_GRAPHQL_URL
+REACT_APP_AUTH0_DOMAIN
+REACT_APP_AUTH0_CLIENT_ID
+REACT_APP_AUTH0_AUDIENCE
+REACT_APP_CLOUDNARY_CLOUD_NAME
+REACT_APP_CLOUDNARY_UPLOAD_PRESET
+REACT_APP_ALGOLIA_APP_ID
+REACT_APP_ALGOLIA_API_KEY
+REACT_APP_ALGOLIA_INDEX

.github/workflows/docker-images.yml

@@ -0,0 +1,26 @@
+name: Docker Image CI
+on:
+  push:
+    branches: [main]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: docker login
+        env:
+          DOCKER_USER: ${{secrets.DOCKER_USERNAME}}
+          DOCKER_PASSWORD: ${{secrets.DOCKER_PASSWORD}}
+        run: docker login -u $DOCKER_USERNAME -p $DOCKER_PASSWORD
+
+      - name: Build the Docker images
+        run: docker build . --file web/Dockerfile --tag eyuelberga/peernotes-web:$(date +%s)
+        run: docker build . --file web/Dockerfile --build-arg "ENV=TEST" --tag eyuelberga/peernotes-web-test:$(date +%s)
+        run: docker build . --file algolia-webhook/Dockerfile --build-arg "ENV=TEST" --tag eyuelberga/peernotes-algolia-webhook:$(date +%s)
+
+      - name: Push to docker hub
+        run: docker push eyuelberga/peernotes-web
+        run: docker push eyuelberga/peernotes-web-test
+        run: docker push eyuelberga/peernotes-algolia-webhook

.gitignore

@@ -0,0 +1,24 @@
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+/cypress/videos
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+.env
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.eslintcache

.huskyrc

@@ -0,0 +1,7 @@
+{
+  "hooks": {
+    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+    "pre-commit": "lint-staged",
+    "prepare-commit-msg": "exec < /dev/tty && git cz --hook"
+  }
+}

.lintstagedrc

@@ -0,0 +1,8 @@
+{
+  "**/*.{ts,tsx,js,jsx}": [
+    "prettier --write"
+  ],
+  "**/*.{md,yml,json,babelrc,eslintrc,prettierrc}": [
+    "prettier --write"
+  ]
+}

.prettierrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  semi: true,
+  trailingComma: 'all',
+  singleQuote: true,
+};

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+-   Demonstrating empathy and kindness toward other people
+-   Being respectful of differing opinions, viewpoints, and experiences
+-   Giving and gracefully accepting constructive feedback
+-   Accepting responsibility and apologizing to those affected by our mistakes,
+    and learning from the experience
+-   Focusing on what is best not just for us as individuals, but for the
+    overall community
+
+Examples of unacceptable behavior include:
+
+-   The use of sexualized language or imagery, and sexual attention or
+    advances of any kind
+-   Trolling, insulting or derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or email
+    address, without their explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+eyuel.berga@yahoo.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Eyuel Berga Woldemichael
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,79 @@
+<p align="center">
+  <a href="https://github.com/eyuelberga/peernotes">
+    <img src="https://github.com/eyuelberga/peernotes/blob/main/assets/logo.png?raw=true" alt="Peer Notes logo" width="300" />
+  </a>
+</p>
+
+<br>
+
+<p align="center">
+<a href="https://github.com/eyuelberga/peernotes/blob/main/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/eyuelberga/peernotes"></a>
+</p>
+<br />
+
+Peer Notes is a web application for High School Students to share and access school notes.
+
+The project was built using React for the frontend web app, Auth0 for managing user authentication, Hasura GraphQL Engine, Algolia for search and also Cloudnary for image upload.
+
+## Getting Started
+
+To quickly run the project, use docker-compose. But before that, you need to setup some environment variables which are listed below:
+
+```
+HASURA_GRAPHQL_ADMIN_SECRET
+HASURA_GRAPHQL_METADATA_DATABASE_URL
+HASURA_GRAPHQL_JWT_SECRET
+POSTGRES_PASSWORD
+ALGOLIA_ADMIN_API_KEY
+ALGOLIA_APP_ID
+ALGOLIA_INDEX
+HASURA_GRAPHQL_URL
+REACT_APP_AUTH0_DOMAIN
+REACT_APP_AUTH0_CLIENT_ID
+REACT_APP_AUTH0_AUDIENCE
+REACT_APP_CLOUDNARY_CLOUD_NAME
+REACT_APP_CLOUDNARY_UPLOAD_PRESET
+REACT_APP_ALGOLIA_APP_ID
+REACT_APP_ALGOLIA_API_KEY
+REACT_APP_ALGOLIA_INDEX
+
+```
+
+Create a `.env` file in the project root and add values to the above variables. **Please note**, you need to create Algolia and Cloudnary account to get the values for some of the environment variables.
+
+## Setting up Auth0
+
+In order for Hasura and Auth0 to work you need to setup two actions, which can be found at `/auth0/actions` folder.
+
+Both actions have two environment variables you need to supply:
+
+```
+PEER_NOTES_HASURA_GRAPHQL_HTTPS_URL: absolute url to the GraphQL API
+PEER_NOTES_HASURA_ADMIN_SECRET: admin secret for the API
+
+```
+
+- `hasura-jwt-clams` action should be added to the `Login` flow
+- `sync-user-with-db` action should be added to the `Post User Registration` flow
+
+You also need to get the JWT secret from Auth0. use [this link to get the JWT config](https://hasura.io/jwt-config/).
+
+## Setting up Algolia
+
+The setup for Algolia is quite forward. You just need to get the following information from your Dashboard and set them as environment variables:
+
+- APP ID
+- API KEY
+- INDEX
+
+You do however need to do some configuration to make sure search results are displayed in a certain order and allow filtering. You can configure this in your Dashboard configuration menu under `RELEVANCE ESSENTIALS` and `FILTERING AND FACETING`
+
+Run the following command on the root of the project folder.
+
+```shell
+$ docker-compose up
+```
+
+## License
+
+MIT © [Eyuel Berga](https://github.com/eyuelberga)

algolia-webhook/.dockerignore

@@ -0,0 +1,10 @@
+node_modules
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+.env
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

algolia-webhook/.env.example

@@ -0,0 +1,4 @@
+ALGOLIA_ADMIN_API_KEY
+ALGOLIA_APP_ID
+HASURA_HTTPS_URL
+HASURA_ADMIN_SECRET

algolia-webhook/.gitignore

@@ -0,0 +1,2 @@
+.env
+node_modules

algolia-webhook/Dockerfile

@@ -0,0 +1,11 @@
+FROM node:14
+
+WORKDIR /app
+
+COPY . .
+
+RUN yarn
+
+EXPOSE 3000
+
+CMD [ "node", "index.js" ]

algolia-webhook/README.md

@@ -0,0 +1 @@
+# Algolia