feat: ship it

.gitignore

@@ -138,3 +138,6 @@ dist
 /playwright-report/
 /blob-report/
 /playwright/.cache/
+
+# task file
+.todo

CONTRIBUTING.md

@@ -0,0 +1,149 @@
+# 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 ✨
+
+First things first, make sure you read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
+
+In this guide, you will get an overview of the project structure and setup, as well as the workflow from opening an issue, creating a PR, reviewing, and merging the PR.
+
+## Table of contents
+
+- [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)
+ - [Some simple rules](#some-simple-rules)
+ - [The tech stack](#the-tech-stack)
+ - [Getting stuff running](#getting-stuff-running)
+ - [Cloning the repo](#cloning-the-repo)
+ - [Bun](#bun)
+ - [Installing dependencies](#installing-dependencies)
+ - [Environment Variables](#environment-variables)
+ - [Running stuff](#running-stuff)
+ - [Closing notes](#closing-notes)
+
+## New contributor guide
+
+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
+
+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/noodle-run/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 start working on the issue.
+- Once work has started, you can create a draft pull request and remember 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 or why it can't 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 is already being worked on by 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 Runtime:
+
+- [Bun](https://bun.sh/)
+
+The Tech Stack:
+
+- [Next.js App Router](https://nextjs.org/)
+- [TailwindCSS](https://tailwindcss.com/)
+- [tRPC](https://trpc.io)
+- [Drizzle ORM](https://orm.drizzle.team/)
+- [ShadCN UI](https://ui.shadcn.com)
+- [NeonDB](https://neon.tech)
+- [Clerk Auth](https://clerk.dev/)
+- [Upstash](https://upstash.com)
+- [Sentry](https://sentry.io)
+- [Resend](https://resend.com)
+
+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.
+
+## Getting stuff running
+
+### Cloning the repo
+
+To clone the repo, you firstly need to [fork](https://github.com/noodle-run/noodle/fork) it, and then clone your copy of noodle locally.
+
+```bash
+git clone https://github.com/<your-gh-username>/noodle.git
+```
+
+### Bun
+
+Bun is used as the package manager of Noodle, with Bun, you don't need to have NodeJS installed at all on your system to be able to run Noodle. The only tool you need to install dependencies & run Noodle is Bun!
+
+To install bun, head over to [their website](https://bun.sh/) which will tell you how to get it installed on your system.
+
+To check that you have Bun installed, simply run the following command:
+
+```bash
+bun --version
+```
+
+If this commands outputs a version number, you're all good to go.
+
+### Installing dependencies
+
+With bun installed on your machine, the next step would be to install the dependencies that Noodle relies upon to work, to do this, run the following command:
+
+```bash
+bun install
+```
+
+### Environment Variables
+
+Now that Bun & dependencies has been installed, 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, you will need to sign up to some services in the process.
+
+You can checkout which variables are needed and which are optional in the `src/env.ts` file.
+
+### Running stuff
+
+```bash
+# Run the project's dev server
+bun dev
+
+# Run e2e tests
+bun playwright test
+
+# Build the project
+bun run build
+
+# Run the built project in production mode
+bun start
+
+# Run the typecheck script
+bun typecheck
+
+# Lint using ESLint
+bun lint
+
+# Format using Prettier
+bun format
+```
+
+## 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).

README.md

@@ -1,20 +1,33 @@
-# Noodle
-
-> Rethinking Student Productivity
-
-## Todo for `next` branch to be merged into `main`
-
-- [x] Landing page.
-- [x] Early access page.
-- [x] Terms and conditions page.
-- [x] Privacy policy page.
-- [x] Blog page.
-- [x] Write a blog post about Noodle's resurrection.
-- [x] Responsiveness.
-- [ ] README.md.
-- [ ] CONTRIBUTING.md.
-- [ ] Posthog.
-- [x] Sentry.
-- [ ] Update GitHub repo about & tags.
-- [ ] Update privacy, terms and blog post dates.
-- [x] 404 page
+<div align="center">
+ <img src="https://github.com/noodle-run/noodle/blob/main/public/logo.svg?raw=true" alt="Noodle logo" width="75">
+ <h1>Noodle <br> Rethinking Student Productivity</h1>
+ <br>
+</div>
+
+> **Warning**
+> This is a work-in-progress and not the finished product.
+>
+> Noodle is still in active development towards a minimal viable product (MVP).
+>
+> Follow me on twitter [@ixahmedxii](https://twitter.com/ixahmedxii) for updates.
+
+![Noodle Preview](https://github.com/noodle-run/noodle/blob/main/public/preview.png?raw=true)
+
+<p align="center" style="color:dodgerblue;"><strong>⚠️ This is a UI design mockup of what the platform will look like, it is not the current state of the project.</strong></p>
+
+## Purpose
+
+Noodle as an idea came from the struggles that I faced during my university years. I was using multiple apps to try and stay on track with my studies, and I thought to myself, why is there no singular app that can do everything a student needs to stay on track with their studies? Like a GitHub but for students.
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=noodle-run/noodle#gh-light-mode-only)](https://star-history.com/#noodle-run/noodle#gh-light-mode-only)
+[![Star History Chart](https://api.star-history.com/svg?repos=noodle-run/noodle&theme=dark#gh-dark-mode-only)](https://star-history.com/#noodle-run/noodle#gh-dark-mode-only)
+
+## Contributing
+
+If you would like to contribute to Noodle, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file to get started.
+
+## License
+
+Noodle is open source and available under the [AGPL-3.0-or-later](./LICENSE) license.

cspell.config.yaml

@@ -25,6 +25,7 @@ words:
  - hookform
  - ianvs
  - ixahmedxi
+ - ixahmedxii
  - jiti
  - lockb
  - lucide

package.json

@@ -72,6 +72,8 @@
  "@trpc/react-query": "next",
  "@trpc/server": "next",
  "@upstash/redis": "^1.31.3",
+ "@vercel/analytics": "^1.3.1",
+ "@vercel/speed-insights": "^1.0.11",
  "class-variance-authority": "^0.7.0",
  "clsx": "^2.1.1",
  "drizzle-orm": "^0.31.2",

src/app/layout.tsx

@@ -8,6 +8,8 @@ import './globals.css';
 import { ThemeProvider } from 'next-themes';
 
 import type { PropsWithChildren } from 'react';
+import { Analytics } from '@vercel/analytics/react';
+import { SpeedInsights } from '@vercel/speed-insights/next';
 
 import { constructMetadata } from '@/lib/utils';
 import { Toaster } from '@/primitives/sonner';
@@ -32,6 +34,8 @@ export default function RootLayout({ children }: PropsWithChildren) {
  <ThemeProvider attribute="class" disableTransitionOnChange>
  {children}
  <Toaster />
+ <Analytics />
+ <SpeedInsights />
  </ThemeProvider>
  </body>
  </html>

src/content/blog/noodle-resurgence.md

@@ -1,6 +1,6 @@
 ---
 title: Noodle is back to life!
-publishedAt: Jun 7th, 2024
+publishedAt: Jun 8th, 2024
 summary: After a brief period of absence, Noodle is back again in the works. Learn more about what we have been up to, the story until now and what's next in the future of Noodle!
 image: /_static/blog/noodle-resurrection.jpg
 ---

src/content/legal/privacy.md

@@ -1,6 +1,6 @@
 ---
 title: Privacy Policy
-effectiveDate: Jun 6th, 2024
+effectiveDate: Jun 8th, 2024
 ---
 
 ## 1. Introduction

src/content/legal/tos.md

@@ -1,6 +1,6 @@
 ---
 title: Terms of Service
-effectiveDate: Jun 6th, 2024
+effectiveDate: Jun 8th, 2024
 ---
 
 ## 1. Introduction