diff --git a/.all-contributorsrc b/.all-contributorsrc deleted file mode 100644 index 1542f099..00000000 --- a/.all-contributorsrc +++ /dev/null @@ -1,175 +0,0 @@ -{ - "files": [ - "README.md" - ], - "imageSize": 100, - "commit": false, - "commitType": "docs", - "commitConvention": "angular", - "contributors": [ - { - "login": "ixahmedxi", - "name": "Ahmed Elsakaan", - "avatar_url": "https://avatars.githubusercontent.com/u/20271968?v=4", - "profile": "https://elsakaan.dev", - "contributions": [ - "audio", - "video", - "code", - "doc", - "a11y", - "bug", - "blog", - "business", - "content", - "data", - "design", - "example", - "eventOrganizing", - "financial", - "fundingFinding", - "ideas", - "maintenance", - "mentoring", - "platform", - "plugin", - "projectManagement", - "promotion", - "question", - "research", - "review", - "security", - "tool", - "translation", - "test", - "tutorial", - "talk", - "userTesting", - "infra" - ] - }, - { - "login": "antoniobfm", - "name": "Antônio Moraes", - "avatar_url": "https://avatars.githubusercontent.com/u/23482001?v=4", - "profile": "https://github.com/antoniobfm", - "contributions": [ - "doc" - ] - }, - { - "login": "nrwl", - "name": "Nrwl", - "avatar_url": "https://avatars.githubusercontent.com/u/23692104?v=4", - "profile": "https://nrwl.io", - "contributions": [ - "financial" - ] - }, - { - "login": "liamsegura", - "name": "Liam Segura", - "avatar_url": "https://avatars.githubusercontent.com/u/102547056?v=4", - "profile": "https://www.liamsegura.com", - "contributions": [ - "doc" - ] - }, - { - "login": "misternano", - "name": "Nano", - "avatar_url": "https://avatars.githubusercontent.com/u/22123308?v=4", - "profile": "https://nanos.club", - "contributions": [ - "code" - ] - }, - { - "login": "jrysana", - "name": "John—Rysana", - "avatar_url": "https://avatars.githubusercontent.com/u/51100181?v=4", - "profile": "http://rysana.com", - "contributions": [ - "code" - ] - }, - { - "login": "mabdulker", - "name": "Max Abdulkerimov", - "avatar_url": "https://avatars.githubusercontent.com/u/97461667?v=4", - "profile": "https://github.com/mabdulker", - "contributions": [ - "code" - ] - }, - { - "login": "JeKaQM", - "name": "Jeno Manivcsuk", - "avatar_url": "https://avatars.githubusercontent.com/u/74925827?v=4", - "profile": "https://github.com/JeKaQM", - "contributions": [ - "code" - ] - }, - { - "login": "i-naeem", - "name": "Muhammad Naeem", - "avatar_url": "https://avatars.githubusercontent.com/u/100943448?v=4", - "profile": "https://i-naeem.github.io", - "contributions": [ - "code" - ] - }, - { - "login": "xhayper", - "name": "hayper", - "avatar_url": "https://avatars.githubusercontent.com/u/46065349?v=4", - "profile": "http://website-xhayper.vercel.app", - "contributions": [ - "doc" - ] - }, - { - "login": "masterujjval", - "name": "Ujjwal gupta", - "avatar_url": "https://avatars.githubusercontent.com/u/64778409?v=4", - "profile": "https://github.com/masterujjval", - "contributions": [ - "doc" - ] - }, - { - "login": "faizan07", - "name": "Faizanul Haque", - "avatar_url": "https://avatars.githubusercontent.com/u/14312760?v=4", - "profile": "https://github.com/faizan07", - "contributions": [ - "content" - ] - }, - { - "login": "ShadyD45", - "name": "Shubham Dhumal", - "avatar_url": "https://avatars.githubusercontent.com/u/54709753?v=4", - "profile": "https://github.com/ShadyD45", - "contributions": [ - "content" - ] - }, - { - "login": "gedeondoescode", - "name": "Gedeon", - "avatar_url": "https://avatars.githubusercontent.com/u/75461444?v=4", - "profile": "https://gedeondoescode.com", - "contributions": [ - "code" - ] - } - ], - "contributorsPerLine": 7, - "skipCi": true, - "repoType": "github", - "repoHost": "https://github.com", - "projectName": "noodle", - "projectOwner": "ixahmedxi" -} diff --git a/.env.example b/.env.example index 7cb5e280..1700a3ad 100644 --- a/.env.example +++ b/.env.example @@ -1,17 +1,19 @@ -# NX -NX_CLOUD_ACCESS_TOKEN="NzIyMjllYzgtMzlkYS00N2U4LThjOGItOGU3YzM0OGQyMTk2fHJlYWQtb25seQ==" +# Sqlite database url (you can leave this as is) +DATABASE_URL="file:./dev.db" -# Database -DATABASE_URL="postgres://username:password@localhost:5432/db_name" +# If you're using turso for the DB, you will need this too +DATABASE_AUTH_TOKEN= -# Redis -UPSTASH_REDIS_REST_URL="" -UPSTASH_REDIS_REST_TOKEN="" +# Clerk Environment Variables +NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY= +CLERK_SECRET_KEY= -# Clerk authentication -NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY= -CLERK_SECRET_KEY= +# Don't need to change those NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/app -NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/app \ No newline at end of file +NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/app + +# Redis (Upstash) +UPSTASH_REDIS_REST_URL= +UPSTASH_REDIS_REST_TOKEN= \ No newline at end of file diff --git a/.eslintignore b/.eslintignore deleted file mode 100644 index eaa4a7a8..00000000 --- a/.eslintignore +++ /dev/null @@ -1 +0,0 @@ -!.storybook \ No newline at end of file diff --git a/.eslintrc.cjs b/.eslintrc.cjs index 3a812c96..79cb5118 100644 --- a/.eslintrc.cjs +++ b/.eslintrc.cjs @@ -1,9 +1,35 @@ -/** @type {import('eslint').Linter.Config} */ +/** @type {import("eslint").Linter.Config} */ const config = { - root: true, - extends: ['noodle/base'], + parser: "@typescript-eslint/parser", parserOptions: { - tsconfigRootDir: __dirname, + project: true, + }, + plugins: ["@typescript-eslint"], + extends: [ + "next/core-web-vitals", + "plugin:@typescript-eslint/recommended-type-checked", + "plugin:@typescript-eslint/stylistic-type-checked", + ], + rules: { + // These opinionated rules are enabled in stylistic-type-checked above. + // Feel free to reconfigure them to your own preference. + "@typescript-eslint/array-type": "off", + "@typescript-eslint/consistent-type-definitions": "off", + + "@typescript-eslint/consistent-type-imports": [ + "warn", + { + prefer: "type-imports", + fixStyle: "inline-type-imports", + }, + ], + "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }], + "@typescript-eslint/no-misused-promises": [ + 2, + { + checksVoidReturn: { attributes: false }, + }, + ], }, }; diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 6a0b3266..8e63052e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,9 +1,9 @@ --- name: Bug report about: Create a report to help us improve -title: '[BUG]' +title: "[BUG]" labels: bug -assignees: '' +assignees: "" --- **Describe the bug** @@ -20,8 +20,8 @@ If applicable, add screenshots to help explain your problem. **Information (please complete the following information):** -- Node version [e.g. 18.15.0] -- Pnpm version [e.g. 8.6.6] +- Node version [e.g. 18.17.0] +- Pnpm version [e.g. 8.9.2] **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 9223000e..a8d14802 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,9 +1,9 @@ --- name: Feature request about: Suggest an idea for this project -title: '[FEAT]' +title: "[FEAT]" labels: enhancement -assignees: '' +assignees: "" --- **Is your feature request related to a problem? Please describe.** diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 53f0694c..8995adb3 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -6,88 +6,46 @@ on: pull_request: env: - NX_CLOUD_DISTRIBUTED_EXECUTION: true - NX_CLOUD_DISTRIBUTED_EXECUTION_AGENT_COUNT: 3 - NX_BRANCH: ${{ github.event.number || github.ref_name }} - NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }} - VOLTA_FEATURE_PNPM: 1 - SKIP_ENV_VALIDATION: true + # Database + DATABASE_URL: file:./ci.db + + # Clerk NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY: ${{secrets.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY}} CLERK_SECRET_KEY: ${{secrets.CLERK_SECRET_KEY}} + NEXT_PUBLIC_CLERK_SIGN_IN_URL: /sign-in + NEXT_PUBLIC_CLERK_SIGN_UP_URL: /sign-up + NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL: /app + NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL: /app + + # Upstash + UPSTASH_REDIS_REST_URL: ${{secrets.UPSTASH_REDIS_REST_URL}} + UPSTASH_REDIS_REST_TOKEN: ${{secrets.UPSTASH_REDIS_REST_TOKEN}} + + # Volta + VOLTA_FEATURE_PNPM: 1 jobs: main: name: CI runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - name: Checkout [Pull Request] - if: ${{ github.event_name == 'pull_request' }} - with: - ref: ${{ github.event.pull_request.head.sha }} - fetch-depth: 0 - - - uses: actions/checkout@v3 - name: Checkout [Default Branch] - if: ${{ github.event_name != 'pull_request' }} - with: - fetch-depth: 0 - - - name: Derive SHAs for `nx affected` commands - uses: nrwl/nx-set-shas@v3 - with: - main-branch-name: 'main' + - name: Checkout + uses: actions/checkout@v4 - - name: Setup volta + - name: Setup Volta uses: volta-cli/action@v4 + - name: Install Node & pnpm + run: volta install node && volta install pnpm + - name: Install dependencies run: pnpm install - - name: Initialize the Nx Cloud distributed CI run - run: pnpm nx-cloud start-ci-run - - - name: Run commands in parallel - run: | - pids=() - - NX_CLOUD_DISTRIBUTED_EXECUTION=false pnpm nx-cloud record -- pnpm format:check & pids+=($!) - - pnpm nx affected -t lint --parallel=3 & pids+=($!) - pnpm nx affected -t typecheck --parallel=3 & pids+=($!) - NX_CLOUD_DISTRIBUTED_EXECUTION=false pnpm nx affected -t build --parallel=3 & pids+=($!) + - name: Check format + run: pnpm format:check - # run all commands in parallel and bail if one of them fails - for pid in "${pids[@]}"; do - if ! wait $pid; then - echo "Process $pid failed" - exit 1 - fi - done - - exit 0 - - - name: Stop all running agents for this CI run - if: ${{ always() }} - run: pnpm nx-cloud stop-all-agents - - agents: - name: Agent ${{ matrix.agent }} - runs-on: ubuntu-latest - strategy: - matrix: - agent: [1, 2, 3] - steps: - - name: Checkout - uses: actions/checkout@v3 - - - name: Setup volta - uses: volta-cli/action@v4 - - - name: Install dependencies - run: pnpm install + - name: Check lint + run: pnpm lint - - name: Start Nx Agent ${{ matrix.agent }} - run: pnpm nx-cloud start-agent - env: - NX_AGENT_NAME: ${{matrix.agent}} + - name: Build + run: pnpm build diff --git a/.gitignore b/.gitignore index c9e2564c..a4d14ebe 100644 --- a/.gitignore +++ b/.gitignore @@ -1,126 +1,43 @@ -# Logs -logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* -lerna-debug.log* -.pnpm-debug.log* - -# Diagnostic reports (https://nodejs.org/api/report.html) -report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json - -# Runtime data -pids -*.pid -*.seed -*.pid.lock - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage -*.lcov - -# nyc test coverage -.nyc_output - -# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# Bower dependency directory (https://bower.io/) -bower_components - -# node-waf configuration -.lock-wscript - -# Compiled binary addons (https://nodejs.org/api/addons.html) -build/Release - -# Dependency directories -node_modules/ -jspm_packages/ - -# Snowpack dependency directory (https://snowpack.dev/) -web_modules/ - -# TypeScript cache -*.tsbuildinfo +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. -# Optional npm cache directory -.npm +# dependencies +/node_modules +/.pnp +.pnp.js -# Optional eslint cache -.eslintcache +# testing +/coverage -# Optional stylelint cache -.stylelintcache +# next.js +/.next/ +/out/ -# Microbundle cache -.rpt2_cache/ -.rts2_cache_cjs/ -.rts2_cache_es/ -.rts2_cache_umd/ +# production +/build -# Optional REPL history -.node_repl_history +# misc +.DS_Store +*.pem -# Output of 'npm pack' -*.tgz - -# Yarn Integrity file -.yarn-integrity +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* -# dotenv environment variable files +# local env files +.env*.local .env -.env.development.local -.env.test.local -.env.production.local -.env.local - -# parcel-bundler cache (https://parceljs.org/) -.cache -.parcel-cache - -# Next.js build output -.next -out - -# Nuxt.js build / generate output -.nuxt -dist - -# Gatsby files -.cache/ -# Comment in the public line in if your project uses Gatsby and not Next.js -# https://nextjs.org/blog/next-9-1#public-directory-support -# public +.env.* +!.env.example -# vuepress build output -.vuepress/dist +# vercel +.vercel -# vuepress v2.x temp and cache directory -.temp -.cache - -# Docusaurus cache and generated files -.docusaurus - -# Serverless directories -.serverless/ - -# FuseBox cache -.fusebox/ - -# DynamoDB Local files -.dynamodb/ - -# TernJS port file -.tern-port - -# Stores VSCode versions used for testing VSCode extensions -.vscode-test +# typescript +*.tsbuildinfo +next-env.d.ts -# DS files -.DS_Store \ No newline at end of file +# DB files +*.db +*.sqlite +*.sqlite3 diff --git a/.husky/commit-msg b/.husky/commit-msg deleted file mode 100755 index 192955d5..00000000 --- a/.husky/commit-msg +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env sh -. "$(dirname -- "$0")/_/husky.sh" - -pnpm -- commitlint --edit ${1} diff --git a/.husky/pre-commit b/.husky/pre-commit deleted file mode 100755 index a5a29d9f..00000000 --- a/.husky/pre-commit +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env sh -. "$(dirname -- "$0")/_/husky.sh" - -pnpm lint-staged diff --git a/.lintstagedrc.mjs b/.lintstagedrc.mjs deleted file mode 100644 index 480e3c86..00000000 --- a/.lintstagedrc.mjs +++ /dev/null @@ -1,4 +0,0 @@ -export default { - '*.{js,jsx,ts,tsx}': ['prettier --list-different'], - '*.{css,html,json,md,mdx,yaml,yml}': ['prettier --list-different'], -}; diff --git a/.npmrc b/.npmrc index 0e997379..cb158871 100644 --- a/.npmrc +++ b/.npmrc @@ -1,3 +1 @@ -engine-strict=true -prefer-workspace-packages=true -node-linker=hoisted \ No newline at end of file +public-hoist-pattern[]=*@nextui-org/* \ No newline at end of file diff --git a/.prettierignore b/.prettierignore index fbe29345..0fdeb42f 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,9 +1,4 @@ -pnpm-lock.yaml +node_modules .next -coverage -storybook-static -dist -playwright-report -test-results -.all-contributorsrc -packages/db/drizzle \ No newline at end of file +bun.lockb +pnpm-lock.yaml \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index c6bf7b63..00000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "recommendations": [ - "esbenp.prettier-vscode", - "dbaeumer.vscode-eslint", - "amodio.toggle-excluded-files", - "formulahendry.auto-close-tag", - "formulahendry.auto-rename-tag", - "aaron-bond.better-comments", - "mikestead.dotenv", - "EditorConfig.EditorConfig", - "yzhang.markdown-all-in-one", - "unifiedjs.vscode-mdx", - "nrwl.angular-console", - "ms-playwright.playwright", - "yoavbls.pretty-ts-errors", - "bradlc.vscode-tailwindcss" - ] -} diff --git a/.vscode/settings.json b/.vscode/settings.json index 4f04b207..0bce4f35 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,17 +1,13 @@ { - "typescript.tsdk": "node_modules/typescript/lib", "editor.defaultFormatter": "esbenp.prettier-vscode", - "eslint.rules.customizations": [ - { - "rule": "*", - "severity": "warn" - } - ], + "editor.formatOnSave": true, "editor.codeActionsOnSave": { - "source.fixAll.eslint": true + "source.fixAll.eslint": true, + "source.organizeImports": true }, - "editor.formatOnSave": true, + "typescript.tsdk": "node_modules/typescript/lib", "tailwindCSS.experimental.classRegex": [ - ["cva\\(([^)]*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"] + ["cva\\(([^)]*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"], + ["cx\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"] ] } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2834151..7fa0d45f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Welcome to Noodle docs contributing guide +# Noodle's contributing guidelines Thank you for your interest in contributing to our project! Any contribution is highly appreciated and will be reflected on our project ✨ @@ -8,7 +8,7 @@ In this guide, you will get an overview of the project structure and setup, as w ## Table of contents -- [Welcome to Noodle docs contributing guide](#welcome-to-noodle-docs-contributing-guide) +- [Noodle's contributing guidelines](#noodles-contributing-guidelines) - [Table of contents](#table-of-contents) - [New contributor guide](#new-contributor-guide) - [Getting your foot in](#getting-your-foot-in) @@ -18,6 +18,9 @@ In this guide, you will get an overview of the project structure and setup, as w - [Cloning the repo](#cloning-the-repo) - [Volta](#volta) - [Environment Variables](#environment-variables) + - [Configuring your Database](#configuring-your-database) + - [Configuring Clerk](#configuring-clerk) + - [Configuring Upstash](#configuring-upstash) - [Installing dependencies](#installing-dependencies) - [Running stuff](#running-stuff) - [Closing notes](#closing-notes) @@ -27,8 +30,11 @@ In this guide, you will get an overview of the project structure and setup, as w Here are some resources to help you get started with open source contributions: - [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) + - [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) + - [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) + - [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) ## Getting your foot in @@ -36,38 +42,62 @@ Here are some resources to help you get started with open source contributions: Our preferred way of providing the opportunity for people to contribute to Noodle is through a process that starts with creating a new issue, the summary of the workflow that you can expect and should adhere to is the following: - You see an area of improvement in the code base, this could be a fix, feature, refactoring...etc + - Create an [issue](https://github.com/ixahmedxi/noodle/issues) on our Github repository. + - Wait until a team member discusses the issue with you, and if both parties are in agreement, you can assign yourself to the issue. + - Start working on the issue, creating a draft pull request and remembering to link your pull request with the issue. + - Once the work is complete, change the status of the pull request to ready for review. + - We will review the pull request and if all is good, congratulations! 🥳 you are now a Noodle contributor! + - If not, we will explain the changes that need to be made for the pull request to be merged. +If you would like to be more involved in the development of Noodle, we would like to invite you to our [Discord Server](https://discord.gg/SERySfj8Eg) where we can have a chat together and get you involved in the project! + ### Some simple rules -- Don't work on an issue that has already been assigned to someone. +- Don't work on an issue that has already been assigned to someone else. + - Don't work on something without getting a team member's approval, this is to not waste your time by making you work on something that won't be merged. + - Don't demand for your pull request to be approved and merged. + - Be nice to everyone involved, we are aiming to create a positive community around collaborating and contributing towards Noodle's development. ## The tech stack -The Building blocks: +The Environment: - [NodeJS](https://nodejs.org/en) - [Pnpm](https://pnpm.io/) -- [NX](https://nx.dev) -The actual stack: +The Tech Stack: + +- [Next.js App Router](https://nextjs.org/) -- [Next.js](https://nextjs.org/) - [TailwindCSS](https://tailwindcss.com/) + - [tRPC](https://trpc.io) + - [Drizzle ORM](https://orm.drizzle.team/) +- [NextUI](https://nextui.org/) + +- [Sqlite](https://www.sqlite.org/index.html) + +- [SlateJS](https://docs.slatejs.org/) + +- [Plate](https://platejs.org/) + +- [Clerk Auth](https://clerk.dev/) + Development stuff: - [ESLint](https://eslint.org/) + - [Prettier](https://prettier.io) There are a lot of other technologies being used in this project, however these are the most important and influential bits of it. @@ -113,29 +143,54 @@ And make sure that the version is the same as the one defined in the root `packa Now that Volta has been installed locally on your system, it's time to configure your environment variables so that the project works as expected: -1. Duplicate the `.env.example` file as just `.env` -2. Populate the values with your own +1. Duplicate the `.env.example` file as just `.env` + +2. Populate the values with your own + +#### Configuring your Database + +At Noodle, we are using Turso as our production database, but since this is based on Sqlite, it makes it very easy to run things locally, all you need to have a local DB working is the following in the `.env` file: + +```bash +DATABASE_URL="file:./dev.db" +``` + +This will create a local file in the root of the repository called `dev.db` and things will be stored there, no need to install any technologies to get a database up and running! + +#### Configuring Clerk + +Clerk is our choice of authentication service for Noodle, it's true that it is a paid service but arguably for running a self hosted version of Noodle it is even easier then setting things up yourself especially with OAuth. To configure clerk you need to do the following: + +1. Create your account through [Clerk's dashboard](https://dashboard.clerk.com/) + +2. Add a new application -You will need to create a postgres database and get the URL of it to use as the database for your local instance, we personally use [Neon](https://neon.tech/) as our database provider and hence we just create a development branch that we use instead of creating a local postgres instance. +3. Set up it's name and how you wish to sign in -We also use [Upstash](https://upstash.com/) for rate limiting and a redis instance. +4. In the sidebar, go to "API Keys" -You will also need to configure [Clerk](https://clerk.com/) to be able to use the authentication functionality of Noodle. +5. Copy the publishable key into `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` in your .env file -###### How to configure Clerk +6. Copy the secret key into `CLERK_SECRET_KEY` in your .env file -1. Create your account through [Clerk's dashboard](https://dashboard.clerk.com/) -2. Add a new application -3. Set up it's name and how you wish to sign in -4. In the sidebar, go to "API Keys" -5. Copy the publishable key into `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` in your .env file -6. Copy the secret key into `CLERK_SECRET_KEY` in your .env file +And now you got Auth! -Also, if you want your own personal [Nx Cloud](https://cloud.nx.app/) instance, you will need to create a project on Nx Cloud and replace the default read-only token provided. +#### Configuring Upstash + +1. Create your account through [Upstash's dashboard](https://console.upstash.com) +2. Click on "Create database" +3. Give it a name and a region +4. Enable TLS (SSL) encryption +5. Press create +6. In the "Connect to your database" section, select "@upstash/redis" +7. Copy the url into your `.env` file as `REDIS_URL` key +8. Copy the token into your `.env` file as `REDIS_TOKEN` key + +And that's all for the redis part! ### Installing dependencies -To install the dependencies needed to run Noodle, you need to run `pnpm install`, this will install all of the packages that we use. +To install the dependencies needed to run Noodle, you need to run `pnpm install`, this will install all of the packages that we use. After this is done, you are ready to run Noodle locally! ### Running stuff @@ -156,10 +211,6 @@ pnpm lint pnpm format:write ``` -Also, if in doubt and something is going wrong, `pnpm clean`. - -This is only a subset of the important commands that you will be using throughout your usage of Noodle's codebase. Be sure to check out [the package.json file](./package.json) for the full list and get familiar with [Nx's commands](https://nx.dev/reference/commands) for more complex use cases. - ## Closing notes Again, thank you so much for your interest in contributing to Noodle, we really appreciate it, and if there is anything we can do to help your journey, make sure to join our [Discord Server](https://discord.gg/SERySfj8Eg). diff --git a/LICENSE b/LICENSE index 8c926d46..a4a3fa96 100644 --- a/LICENSE +++ b/LICENSE @@ -1,178 +1,178 @@ GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. +Copyright (C) 2007 Free Software Foundation, Inc. +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. Preamble - The GNU Affero General Public License is a free, copyleft license for +The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software. - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. - Developers that use our General Public Licenses protect your rights +Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software. - A secondary benefit of defending all users' freedom is that +A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public. - The GNU Affero General Public License is designed specifically to +The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to +to the community. It requires the operator of a network server to provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on +users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version. - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license. - The precise terms and conditions for copying, distribution and +The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS - 0. Definitions. +0. Definitions. - "This License" refers to version 3 of the GNU Affero General Public License. +"This License" refers to version 3 of the GNU Affero General Public License. - "Copyright" also means copyright-like laws that apply to other kinds of +"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. - To "modify" a work means to copy from or adapt all or part of the work +To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the +exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. - A "covered work" means either the unmodified Program or a work based +A "covered work" means either the unmodified Program or a work based on the Program. - To "propagate" a work means to do anything with it that, without +To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, +computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. - An interactive user interface displays "Appropriate Legal Notices" +An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If +work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. - 1. Source Code. +1. Source Code. - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source +The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source form of a work. - A "Standard Interface" means an interface that either is an official +A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. - The "System Libraries" of an executable work include anything, other +The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A +implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. - The "Corresponding Source" for a work in object code form means all +The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's +control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source +which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. - The Corresponding Source need not include anything that users +The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. - The Corresponding Source for a work in source code form is that +The Corresponding Source for a work in source code form is that same work. - 2. Basic Permissions. +2. Basic Permissions. - All rights granted under this License are granted for the term of +All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your +content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. - You may make, run and propagate covered works that you do not +You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose +in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works +not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 +Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. +3. Protecting Users' Legal Rights From Anti-Circumvention Law. - No covered work shall be deemed part of an effective technological +No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. - When you convey a covered work, you waive any legal power to forbid +When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or @@ -180,9 +180,9 @@ modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. - 4. Conveying Verbatim Copies. +4. Conveying Verbatim Copies. - You may convey verbatim copies of the Program's source code as you +You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any @@ -190,12 +190,12 @@ non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. - You may charge any price or no price for each copy that you convey, +You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. - 5. Conveying Modified Source Versions. +5. Conveying Modified Source Versions. - You may convey a work based on the Program, or the modifications to +You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: @@ -220,19 +220,19 @@ terms of section 4, provided that you also meet all of these conditions: interfaces that do not display Appropriate Legal Notices, your work need not make them do so. - A compilation of a covered work with other separate and independent +A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work +beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. - 6. Conveying Non-Source Forms. +6. Conveying Non-Source Forms. - You may convey a covered work in object code form under the terms +You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: @@ -278,75 +278,75 @@ in one of these ways: Source of the work are being offered to the general public at no charge under subsection 6d. - A separable portion of the object code, whose source code is excluded +A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. - A "User Product" is either (1) a "consumer product", which means any +A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product +actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. - "Installation Information" for a User Product means any methods, +"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must +a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. - If you convey an object code work under this section in, or with, or +If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply +by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). - The requirement to provide Installation Information does not include a +The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a +the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. - Corresponding Source conveyed, and Installation Information provided, +Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. - 7. Additional Terms. +7. Additional Terms. - "Additional permissions" are terms that supplement the terms of this +"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions +that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. - When you convey a copy of a covered work, you may at your option +When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. - Notwithstanding any other provision of this License, for material you +Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: @@ -373,74 +373,74 @@ that material) supplement the terms of this License with terms: any liability that these contractual assumptions directly impose on those licensors and authors. - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains +restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. - If you add terms to a covered work in accord with this section, you +If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. - Additional terms, permissive or non-permissive, may be stated in the +Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. - 8. Termination. +8. Termination. - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). - However, if you cease all violation of this License, then your +However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. - Moreover, your license from a particular copyright holder is +Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. - Termination of your rights under this section does not terminate the +Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently +this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. - 9. Acceptance Not Required for Having Copies. +9. Acceptance Not Required for Having Copies. - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work +You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, +to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. - 10. Automatic Licensing of Downstream Recipients. +10. Automatic Licensing of Downstream Recipients. - Each time you convey a covered work, the recipient automatically +Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible +propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. - An "entity transaction" is a transaction transferring control of an +An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered +organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could @@ -448,43 +448,43 @@ give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. - 11. Patents. +11. Patents. - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". - A contributor's "essential patent claims" are all patent claims +A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For +consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. - Each contributor grants you a non-exclusive, worldwide, royalty-free +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. - In the following three paragraphs, a "patent license" is any express +In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a +sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. - If you convey a covered work, knowingly relying on a patent license, +If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, @@ -492,13 +492,13 @@ then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have +license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. - If, pursuant to or in connection with a single transaction or +If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify @@ -506,10 +506,10 @@ or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. - A patent license is "discriminatory" if it does not include within +A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered +specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying @@ -521,83 +521,83 @@ for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. - Nothing in this License shall be construed as excluding or limiting +Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. - 12. No Surrender of Others' Freedom. +12. No Surrender of Others' Freedom. - If conditions are imposed on you (whether by court order, agreement or +If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a +excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you +not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. - 13. Remote Network Interaction; Use with the GNU General Public License. +13. Remote Network Interaction; Use with the GNU General Public License. - Notwithstanding any other provision of this License, if you modify the +Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source +means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph. - Notwithstanding any other provision of this License, you have +Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this +combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License. - 14. Revised Versions of this License. +14. Revised Versions of this License. - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions +The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. - Each version is given a distinguishing version number. If the +Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the +Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation. - If the Program specifies that a proxy can decide which future +If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. - 15. Disclaimer of Warranty. +15. Disclaimer of Warranty. - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - 16. Limitation of Liability. +16. Limitation of Liability. - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE @@ -607,9 +607,9 @@ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - 17. Interpretation of Sections 15 and 16. +17. Interpretation of Sections 15 and 16. - If the disclaimer of warranty and limitation of liability provided +If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the @@ -620,17 +620,17 @@ copy of the Program in return for a fee. How to Apply These Terms to Your New Programs - If you develop a new program, and you want it to be of the greatest +If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. - To do so, attach the following notices to the program. It is safest +To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Noodle - Student productivity platform - Copyright (C) 2023 Ahmed Elsakaan + Copyright (C) 2023 NOODLE RUN LTD This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published @@ -647,15 +647,15 @@ the "copyright" line and a pointer to where the full notice is found. Also add information on how to contact you by electronic and paper mail. - If your software can interact with users remotely through a computer +If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its +get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different +of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements. - You should also get your employer (if you work as a programmer) or school, +You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see . diff --git a/README.md b/README.md index f1666d60..1f286829 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,9 @@
- Noodle logo + Noodle logo

Noodle
Rethinking Student Productivity


- - -[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-) - - - > **Warning** > This is a work-in-progress and not the finished product. > @@ -20,7 +14,7 @@ > > Follow me on twitter [@ixahmedxii](https://twitter.com/ixahmedxii) for updates. -![Noodle Preview](https://github.com/ixahmedxi/noodle/blob/main/apps/web/public/preview.png?raw=true) +![Noodle Preview](https://github.com/ixahmedxi/noodle/blob/main/public/preview.png?raw=true)

⚠️ This is a UI design mockup of what the platform will look like, it is not the current state of the project.

@@ -48,44 +42,3 @@ As an open-source platform, Noodle strives to cultivate a community of students [![Star History Chart](https://api.star-history.com/svg?repos=ixahmedxi/noodle#gh-light-mode-only)](https://star-history.com/#ixahmedxi/noodle#gh-light-mode-only) [![Star History Chart](https://api.star-history.com/svg?repos=ixahmedxi/noodle&theme=dark#gh-dark-mode-only)](https://star-history.com/#ixahmedxi/noodle#gh-dark-mode-only) - -
- Stonks GIF -
- -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - - - - - - - - - - - - - - - - -
Ahmed Elsakaan
Ahmed Elsakaan
🔊 📹 💻 📖 ️️️️♿️ 🐛 📝 💼 🖋 🔣 🎨 💡 📋 💵 🔍 🤔 🚧 🧑‍🏫 📦 🔌 📆 📣 💬 🔬 👀 🛡️ 🔧 🌍 ⚠️ ✅ 📢 📓 🚇		Antônio Moraes
Antônio Moraes
📖		Nrwl
Nrwl
💵		Liam Segura
Liam Segura
📖		Nano
Nano
💻		John—Rysana
John—Rysana
💻		Max Abdulkerimov
Max Abdulkerimov
💻
Jeno Manivcsuk
Jeno Manivcsuk
💻		Muhammad Naeem
Muhammad Naeem
💻		hayper
hayper
📖		Ujjwal gupta
Ujjwal gupta
📖		Faizanul Haque
Faizanul Haque
🖋		Shubham Dhumal
Shubham Dhumal
🖋		Gedeon
Gedeon
💻
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome! diff --git a/SECURITY.md b/SECURITY.md index 8c1a48eb..043772dc 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,4 +2,4 @@ ## Vulnerabilities -If it so happens that you find a security vulnerability with the software, please immediately directly email +If it so happens that you find a security vulnerability with the software, please immediately directly email diff --git a/apps/web/.eslintrc.cjs b/apps/web/.eslintrc.cjs deleted file mode 100644 index ae7a1710..00000000 --- a/apps/web/.eslintrc.cjs +++ /dev/null @@ -1,24 +0,0 @@ -const path = require('path'); - -/** @type {import('eslint').Linter.Config} */ -const config = { - extends: ['noodle/react', 'noodle/next'], - parserOptions: { - babelOptions: { - presets: [require.resolve('next/babel')], - }, - }, - rules: { - '@next/next/no-html-link-for-pages': [ - 'error', - path.join(__dirname, 'src', 'pages'), - ], - }, - settings: { - next: { - rootDir: 'apps/web', - }, - }, -}; - -module.exports = config; diff --git a/apps/web/next-env.d.ts b/apps/web/next-env.d.ts deleted file mode 100644 index 4f11a03d..00000000 --- a/apps/web/next-env.d.ts +++ /dev/null @@ -1,5 +0,0 @@ -/// -/// - -// NOTE: This file should not be edited -// see https://nextjs.org/docs/basic-features/typescript for more information. diff --git a/apps/web/next.config.js b/apps/web/next.config.js deleted file mode 100644 index 6443e1e0..00000000 --- a/apps/web/next.config.js +++ /dev/null @@ -1,20 +0,0 @@ -import '@noodle/env'; - -/** @type {import('next').NextConfig} */ -const config = { - reactStrictMode: true, - swcMinify: true, - eslint: { - ignoreDuringBuilds: !!process.env['CI'], - }, - typescript: { - ignoreBuildErrors: !!process.env['CI'], - }, - i18n: { - defaultLocale: 'en', - locales: ['en'], - }, - transpilePackages: ['@noodle/api', '@noodle/db'], -}; - -export default config; diff --git a/apps/web/package.json b/apps/web/package.json deleted file mode 100644 index 2f41ccdf..00000000 --- a/apps/web/package.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "name": "@noodle/web", - "version": "0.1.0", - "private": true, - "description": "Noodle Web App", - "license": "AGPL-3.0", - "author": "Ahmed Elsakaan", - "type": "module", - "scripts": { - "build": "next build", - "dev": "next dev", - "lint": "eslint . --max-warnings 0", - "lint:fix": "pnpm run lint --fix", - "start": "next start", - "typecheck": "tsc --noEmit" - }, - "dependencies": { - "@clerk/nextjs": "^4.23.4", - "@clerk/themes": "^1.7.5", - "@hookform/resolvers": "^3.3.1", - "@noodle/api": "workspace:^", - "@noodle/db": "workspace:^", - "@noodle/editor": "workspace:^", - "@noodle/env": "workspace:^", - "@noodle/ui": "workspace:^", - "@noodle/utils": "workspace:^", - "@radix-ui/react-accordion": "^1.1.2", - "@radix-ui/react-select": "^1.2.2", - "@tanstack/react-query": "^4.33.0", - "@tanstack/react-query-devtools": "^4.33.0", - "@trpc/client": "^10.38.1", - "@trpc/next": "^10.38.1", - "@trpc/react-query": "^10.38.1", - "@trpc/server": "^10.38.1", - "@upstash/ratelimit": "^0.4.4", - "@vercel/analytics": "^1.0.2", - "date-fns": "^2.30.0", - "framer-motion": "^10.16.3", - "lucide-react": "0.263.1", - "next": "13.4.19", - "next-mdx-remote": "^4.4.1", - "next-seo": "^6.1.0", - "next-themes": "^0.2.1", - "react": "18.2.0", - "react-animate-height": "^3.2.2", - "react-dom": "18.2.0", - "react-hook-form": "^7.46.1", - "react-wrap-balancer": "^1.1.0", - "rehype-slug": "^6.0.0", - "remark-gfm": "^3.0.1", - "superjson": "^1.13.1", - "usehooks-ts": "^2.9.1", - "zod": "^3.22.2" - }, - "devDependencies": { - "@noodle/tailwind": "workspace:^", - "@noodle/tsconfig": "workspace:^", - "@types/react": "18.2.21", - "@types/react-dom": "18.2.7", - "autoprefixer": "^10.4.15", - "postcss": "^8.4.29", - "tailwindcss": "^3.3.3" - }, - "volta": { - "extends": "../../package.json" - } -} diff --git a/apps/web/postcss.config.cjs b/apps/web/postcss.config.cjs deleted file mode 100644 index 3b7928c7..00000000 --- a/apps/web/postcss.config.cjs +++ /dev/null @@ -1 +0,0 @@ -module.exports = require('@noodle/tailwind/postcss.config.cjs'); diff --git a/apps/web/public/android-chrome-512x512.png b/apps/web/public/android-chrome-512x512.png deleted file mode 100644 index 6d97ad11..00000000 Binary files a/apps/web/public/android-chrome-512x512.png and /dev/null differ diff --git a/apps/web/public/apple-touch-icon.png b/apps/web/public/apple-touch-icon.png deleted file mode 100644 index 4f1f0f0d..00000000 Binary files a/apps/web/public/apple-touch-icon.png and /dev/null differ diff --git a/apps/web/public/favicon-16x16.png b/apps/web/public/favicon-16x16.png deleted file mode 100644 index dd4fc5e3..00000000 Binary files a/apps/web/public/favicon-16x16.png and /dev/null differ diff --git a/apps/web/public/favicon-32x32.png b/apps/web/public/favicon-32x32.png deleted file mode 100644 index b7eb1fed..00000000 Binary files a/apps/web/public/favicon-32x32.png and /dev/null differ diff --git a/apps/web/public/preview.png b/apps/web/public/preview.png deleted file mode 100644 index b6041ff3..00000000 Binary files a/apps/web/public/preview.png and /dev/null differ diff --git a/apps/web/public/site.webmanifest b/apps/web/public/site.webmanifest deleted file mode 100644 index 478bc64a..00000000 --- a/apps/web/public/site.webmanifest +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/web-manifest.json", - "name": "Noodle | Rethinking Student Productivity", - "short_name": "Noodle", - "icons": [ - { - "src": "/android-chrome-192x192.png", - "sizes": "192x192", - "type": "image/png" - }, - { - "src": "/android-chrome-512x512.png", - "sizes": "512x512", - "type": "image/png" - } - ], - "theme_color": "#161618", - "background_color": "#161618", - "display": "standalone" -} diff --git a/apps/web/public/waves.svg b/apps/web/public/waves.svg deleted file mode 100644 index 7ae8653a..00000000 --- a/apps/web/public/waves.svg +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/apps/web/src/components/Accordion.tsx b/apps/web/src/components/Accordion.tsx deleted file mode 100644 index 4d95235f..00000000 --- a/apps/web/src/components/Accordion.tsx +++ /dev/null @@ -1,58 +0,0 @@ -import * as React from 'react'; -import * as AccordionPrimitive from '@radix-ui/react-accordion'; - -import { cn } from '@noodle/utils'; - -import { Icon } from './Icon'; - -const Accordion = AccordionPrimitive.Root; - -const AccordionItem = React.forwardRef< - React.ElementRef, - React.ComponentPropsWithoutRef ->(({ className, ...props }, ref) => ( - -)); -AccordionItem.displayName = 'AccordionItem'; - -const AccordionTrigger = React.forwardRef< - React.ElementRef, - React.ComponentPropsWithoutRef ->(({ className, children, ...props }, ref) => ( - - svg]:rotate-180', - className, - )} - {...props} - > - {children} - - - -)); -AccordionTrigger.displayName = AccordionPrimitive.Trigger.displayName; - -const AccordionContent = React.forwardRef< - React.ElementRef, - React.ComponentPropsWithoutRef ->(({ className, children, ...props }, ref) => ( - -
{children}
- -)); -AccordionContent.displayName = AccordionPrimitive.Content.displayName; - -export { Accordion, AccordionContent, AccordionItem, AccordionTrigger }; diff --git a/apps/web/src/components/ActiveLink.tsx b/apps/web/src/components/ActiveLink.tsx deleted file mode 100644 index d3dfa72c..00000000 --- a/apps/web/src/components/ActiveLink.tsx +++ /dev/null @@ -1,32 +0,0 @@ -import { forwardRef } from 'react'; -import type { LinkProps } from 'next/link'; -import type { AnchorHTMLAttributes } from 'react'; -import Link from 'next/link'; -import { useRouter } from 'next/router'; - -import { cn } from '@noodle/utils'; - -type ActiveLinkProps = LinkProps & - AnchorHTMLAttributes & { - activeClassName?: string; - }; - -const ActiveLink = forwardRef( - ({ className, activeClassName, href, ...props }, ref) => { - const router = useRouter(); - const active = href === router.pathname; - - return ( - - ); - }, -); - -ActiveLink.displayName = 'ActiveLink'; - -export { ActiveLink }; diff --git a/apps/web/src/components/DashboardPanel.tsx b/apps/web/src/components/DashboardPanel.tsx deleted file mode 100644 index c6b04b83..00000000 --- a/apps/web/src/components/DashboardPanel.tsx +++ /dev/null @@ -1,41 +0,0 @@ -import { type FC } from 'react'; -import format from 'date-fns/format'; - -import { Typography } from '@noodle/ui'; - -import { TaskSkeleton } from './TaskSkeleton'; -import { WeatherData } from './WeatherData'; - -export const DashboardPanel: FC = () => { - const currentDate = new Date(); - const formattedDate = format(currentDate, "eeee, 'the' do 'of' MMMM yyyy"); - - return ( -
-
- - It's - -

- {formattedDate} -

- - - 📌Tasks for today - -
-
- - Really? No tasks for the day? Come on now... - -
-
- {Array.from(Array(12).keys()).map((_, i) => ( - - ))} -
-
-
-
- ); -}; diff --git a/apps/web/src/components/Greeting.tsx b/apps/web/src/components/Greeting.tsx deleted file mode 100644 index 2bcc649e..00000000 --- a/apps/web/src/components/Greeting.tsx +++ /dev/null @@ -1,33 +0,0 @@ -import { ErrorPanel, Skeleton, Typography } from '@noodle/ui'; - -import { api } from '@/utils/api'; - -const Greeting = () => { - const { data, isLoading, error } = api.greeting.get.useQuery(undefined, { - refetchOnWindowFocus: false, - refetchOnMount: false, - }); - - if (isLoading) { - return ( -
- - - -
- ); - } - - if (error) { - return ; - } - - return ( -
- {data.greeting} - {data.quote} -
- ); -}; - -export { Greeting }; diff --git a/apps/web/src/components/Icon.tsx b/apps/web/src/components/Icon.tsx deleted file mode 100644 index c4dbda14..00000000 --- a/apps/web/src/components/Icon.tsx +++ /dev/null @@ -1,19 +0,0 @@ -import { type LucideProps } from 'lucide-react'; -import dynamicIconImports from 'lucide-react/dynamicIconImports'; -import dynamic from 'next/dynamic'; - -export type IconNames = keyof typeof dynamicIconImports; - -const iconNames = Object.keys(dynamicIconImports) as IconNames[]; - -type IconProps = { - name: IconNames; -} & LucideProps; - -const Icon = ({ name, ...props }: IconProps) => { - const LucideIcon = dynamic(dynamicIconImports[name]); - - return ; -}; - -export { Icon, iconNames }; diff --git a/apps/web/src/components/Input.tsx b/apps/web/src/components/Input.tsx deleted file mode 100644 index 5df80576..00000000 --- a/apps/web/src/components/Input.tsx +++ /dev/null @@ -1,52 +0,0 @@ -import React, { useState } from 'react'; - -import { cn } from '@noodle/utils'; - -export type InputProps = { - icon: React.ReactNode; -} & React.InputHTMLAttributes; - -const Input = React.forwardRef( - ({ className, type, icon, ...props }, ref) => { - const [isInputHovered, setIsInputHovered] = useState(false); - const [isInputActive, setIsInputActive] = useState(false); - - return ( -
-
- {icon} -
- { - setIsInputHovered(true); - }} - onMouseLeave={() => { - setIsInputHovered(false); - }} - onFocus={() => { - setIsInputActive(true); - }} - onBlur={() => { - setIsInputActive(false); - }} - /> -
- ); - }, -); -Input.displayName = 'Input'; - -export { Input }; diff --git a/apps/web/src/components/ModuleSkeleton.tsx b/apps/web/src/components/ModuleSkeleton.tsx deleted file mode 100644 index 7c7503f1..00000000 --- a/apps/web/src/components/ModuleSkeleton.tsx +++ /dev/null @@ -1,53 +0,0 @@ -import { type FC } from 'react'; - -import { Skeleton } from '@noodle/ui'; -import { cn } from '@noodle/utils'; - -type ModuleSkeletonProps = { - variant?: 'default' | 'empty'; -}; - -export const ModuleSkeleton: FC = ({ - variant = 'default', -}) => { - return ( - - - - - - - - ); -}; diff --git a/apps/web/src/components/Navbar.tsx b/apps/web/src/components/Navbar.tsx deleted file mode 100644 index a79939ce..00000000 --- a/apps/web/src/components/Navbar.tsx +++ /dev/null @@ -1,151 +0,0 @@ -import { useEffect, useState } from 'react'; -import AnimateHeight from 'react-animate-height'; -import type { MouseEventHandler } from 'react'; -import Link from 'next/link'; -import { useMediaQuery } from 'usehooks-ts'; - -import { Brand } from '@noodle/ui'; - -import { constants } from '@/utils/constants'; -import { Icon } from './Icon'; - -export const Navbar = () => { - const [height, setHeight] = useState<'auto' | number>(0); - const isMobile = useMediaQuery('(max-width: 768px)'); - - useEffect(() => { - if (!isMobile) { - setHeight('auto'); - } - }, [isMobile]); - - const smoothScrollToTop: MouseEventHandler = (e) => { - if (location.pathname === '/') { - e.preventDefault(); - window.scrollTo({ - top: 0, - behavior: 'smooth', - }); - isMobile && setHeight(0); - } - }; - - const smoothScrollToId = - (id: string): MouseEventHandler => - (e) => { - if (location.pathname === '/') { - e.preventDefault(); - window.scrollTo({ - top: (document.getElementById(id)?.offsetTop ?? 0) - 150, - behavior: 'smooth', - }); - isMobile && setHeight(0); - } - }; - - return ( - - ); -}; diff --git a/apps/web/src/components/RecentModules.tsx b/apps/web/src/components/RecentModules.tsx deleted file mode 100644 index 21ddd6be..00000000 --- a/apps/web/src/components/RecentModules.tsx +++ /dev/null @@ -1,43 +0,0 @@ -import { useState } from 'react'; -import AnimateHeight from 'react-animate-height'; - -import { Button } from '@noodle/ui'; - -import { ModuleSkeleton } from './ModuleSkeleton'; - -export const RecentModules = () => { - const [height, setHeight] = useState<'auto' | number>('auto'); - - return ( -
-
-

Recently visited modules

- -
- -
-
- {Array.from(Array(6).keys()).map((_, i) => ( - - ))} -
- - When you decide to become a good student, the recent modules - will appear here - -
-
-
- -
- ); -}; diff --git a/apps/web/src/components/Select.tsx b/apps/web/src/components/Select.tsx deleted file mode 100644 index 41e34d55..00000000 --- a/apps/web/src/components/Select.tsx +++ /dev/null @@ -1,96 +0,0 @@ -'use client'; - -import * as React from 'react'; -import * as SelectPrimitive from '@radix-ui/react-select'; - -import { cn } from '@noodle/utils'; - -import { Icon } from './Icon'; - -const Select = SelectPrimitive.Root; - -const SelectGroup = SelectPrimitive.Group; - -const SelectValue = SelectPrimitive.Value; - -const SelectTrigger = React.forwardRef< - React.ElementRef, - React.ComponentPropsWithoutRef ->(({ className, children, ...props }, ref) => ( - - {children} - - - - -)); -SelectTrigger.displayName = SelectPrimitive.Trigger.displayName; - -const SelectContent = React.forwardRef< - React.ElementRef, - React.ComponentPropsWithoutRef ->(({ className, children, position = 'popper', ...props }, ref) => ( - - - - {children} - - - -)); -SelectContent.displayName = SelectPrimitive.Content.displayName; - -const SelectItem = React.forwardRef< - React.ElementRef, - React.ComponentPropsWithoutRef ->(({ className, children, ...props }, ref) => ( - - - - - - - - {children} - -)); -SelectItem.displayName = SelectPrimitive.Item.displayName; - -export { - Select, - SelectGroup, - SelectValue, - SelectTrigger, - SelectContent, - SelectItem, -}; diff --git a/apps/web/src/components/TaskSkeleton.tsx b/apps/web/src/components/TaskSkeleton.tsx deleted file mode 100644 index 24e973c3..00000000 --- a/apps/web/src/components/TaskSkeleton.tsx +++ /dev/null @@ -1,33 +0,0 @@ -import { type FC } from 'react'; - -import { Skeleton } from '@noodle/ui'; -import { cn } from '@noodle/utils'; - -type TaskSkeletonProps = { - variant?: 'default' | 'empty'; -}; - -export const TaskSkeleton: FC = ({ - variant = 'default', -}) => { - return ( -
-
- -
-
- - - -
-
- ); -}; diff --git a/apps/web/src/components/WeatherData.tsx b/apps/web/src/components/WeatherData.tsx deleted file mode 100644 index 84b7e05b..00000000 --- a/apps/web/src/components/WeatherData.tsx +++ /dev/null @@ -1,32 +0,0 @@ -import { type FC } from 'react'; - -import { useCoords } from '@/hooks/useCoords'; -import { api } from '@/utils/api'; -import { getFormattedWeatherDescription } from '@/utils/getFormattedWeatherCondition'; - -export const WeatherData: FC = () => { - const coords = useCoords(); - const { data: weatherData } = api.weather.getWeatherData.useQuery( - { - latitude: coords?.latitude ?? 0, - longitude: coords?.longitude ?? 0, - }, - { - enabled: !!coords, - refetchOnMount: false, - refetchOnWindowFocus: false, - refetchOnReconnect: false, - }, - ); - - if (!weatherData) return null; - - return ( - - You can expect a 👆 high of {weatherData.main.temp_max.toFixed()}º and a - 👇 low of {weatherData.main.temp_min.toFixed()}º with{' '} - {getFormattedWeatherDescription(weatherData.weather[0]?.description)}{' '} - today. - - ); -}; diff --git a/apps/web/src/hooks/useCoords.ts b/apps/web/src/hooks/useCoords.ts deleted file mode 100644 index 85ab1d21..00000000 --- a/apps/web/src/hooks/useCoords.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { useEffect, useState } from 'react'; - -export const useCoords = () => { - const [coords, setCoords] = useState<{ - latitude: number; - longitude: number; - } | null>(null); - - useEffect(() => { - navigator.geolocation.getCurrentPosition((position) => { - setCoords(position.coords); - }); - }, []); - - return coords; -}; diff --git a/apps/web/src/layouts/dashboard/Navbar.tsx b/apps/web/src/layouts/dashboard/Navbar.tsx deleted file mode 100644 index cad4ded9..00000000 --- a/apps/web/src/layouts/dashboard/Navbar.tsx +++ /dev/null @@ -1,89 +0,0 @@ -import type { Dispatch, FC, SetStateAction } from 'react'; -import { UserButton } from '@clerk/nextjs'; -import { dark } from '@clerk/themes'; -import { useRouter } from 'next/router'; - -import { Button } from '@noodle/ui'; - -import { Icon } from '@/components/Icon'; - -type NavbarProps = { - isSideMenuExpanded: boolean; - setSideMenuExpanded: Dispatch>; -}; - -export const DashboardNavbar: FC = ({ - isSideMenuExpanded = true, - setSideMenuExpanded, -}) => { - const router = useRouter(); - return ( - - ); -}; diff --git a/apps/web/src/layouts/dashboard/SideMenuLink.tsx b/apps/web/src/layouts/dashboard/SideMenuLink.tsx deleted file mode 100644 index cd0f7500..00000000 --- a/apps/web/src/layouts/dashboard/SideMenuLink.tsx +++ /dev/null @@ -1,43 +0,0 @@ -import { type FC } from 'react'; -import type { IconNames } from '@/components/Icon'; -import { motion } from 'framer-motion'; - -import { Button } from '@noodle/ui'; - -import { ActiveLink } from '@/components/ActiveLink'; -import { Icon } from '@/components/Icon'; - -type SideMenuLinkProps = { - href: string; - icon: IconNames; - label: string; - isSideMenuExpanded: boolean; -}; - -export const SideMenuLink: FC = ({ - href, - icon, - label, - isSideMenuExpanded = true, -}) => { - return ( -
  • - -
    • - ); -}; diff --git a/apps/web/src/layouts/dashboard/SideMenuModules.tsx b/apps/web/src/layouts/dashboard/SideMenuModules.tsx deleted file mode 100644 index 1419efda..00000000 --- a/apps/web/src/layouts/dashboard/SideMenuModules.tsx +++ /dev/null @@ -1,23 +0,0 @@ -import { Button, Typography } from '@noodle/ui'; - -import { Icon } from '@/components/Icon'; - -export const SideMenuModules = () => { - return ( -
    -
    - - Modules - - -
    -
    - - Create modules to organize your study material. - -
    -
    - ); -}; diff --git a/apps/web/src/layouts/dashboard/feedback.tsx b/apps/web/src/layouts/dashboard/feedback.tsx deleted file mode 100644 index a0c146f3..00000000 --- a/apps/web/src/layouts/dashboard/feedback.tsx +++ /dev/null @@ -1,162 +0,0 @@ -import { type FC } from 'react'; -import AnimateHeight from 'react-animate-height'; -import { useForm } from 'react-hook-form'; -import { useUser } from '@clerk/nextjs'; -import { zodResolver } from '@hookform/resolvers/zod'; -import { type TRPCErrorResponse } from '@trpc/server/rpc'; -import { motion } from 'framer-motion'; -import { z } from 'zod'; - -import { - Button, - Dialog, - DialogContent, - DialogDescription, - DialogFooter, - DialogHeader, - DialogTitle, - DialogTrigger, - Form, - FormControl, - FormField, - FormItem, - FormLabel, - FormMessage, - Input, - Textarea, - Typography, -} from '@noodle/ui'; - -import { Icon } from '@/components/Icon'; -import { api } from '@/utils/api'; - -const formSchema = z.object({ - email: z.string().email(), - message: z.string().min(3), -}); - -const FeedbackForm: FC<{ email?: string | undefined }> = ({ email }) => { - const { mutateAsync, isLoading, isSuccess } = api.feedback.add.useMutation(); - - const form = useForm>({ - resolver: zodResolver(formSchema), - defaultValues: { - email: email ?? '', - message: '', - }, - }); - - const onSubmit = async (values: z.infer) => { - try { - await mutateAsync(values); - form.reset(); - } catch (error: unknown) { - const err = error as TRPCErrorResponse['error']; - form.setError('root', { - type: 'manual', - message: err.message, - }); - } - }; - - return ( -
    - -
    - ( - - Email Address - - - - - - )} - /> - - ( - - Message - -