This is the repo for the TWT codejam 2022

https://rectilearn.vercel.app/

by Team Rectifiers

Our Goal

To create a website which helps people to study by having multiple games and by allowing users to create study sets.

• Studysets
  Studysets will be similar to notes. A user can create a study set which has a bunch of questions and the corresponding answer. The user can practice by answering the questions in the studyset they made. If they get an answer wrong they will have to enter the correct answer 3 times. This is to make sure that the user will not get that question wrong again.

Our team

• Atlas#0193
• llama#9999
• Sanya#0200
• Rush2618#8281
• VG#8554

Frontend/Backend/Database

• Frontend

  Frontend will be written using Next.js.

  • Devs
    • llama
    • Sanya

• Backend

  Backend will be written in python and will use the FastAPI library.
  JSON Web Tokens will be used as the authentication method.

  • Devs
    • VG
    • Rush2618

• Games

  The games will web based games created using Unity and JavaScript.
  The games will be simple, fun and interactive web games and at a certain time there will be a popup question and they'll need to answer it to continue the playing game

  • Devs
    • Atlas
    • llama
    • Sanya
    • Rush2618
    • VG

• Database

  The database of choice is PostgreSQL.

• Deployment

  The backend will be hosted on Railway

Pages

• Welcome page

  This page is well styled, and should explain the basic features of the website, as well as prompt the user to make an account.

• User dashboard

  Here the user will find the games and studysets which they can use to study.

Extra project details

Project requirements

pnpm

nodejs

pipenv

What's inside?

This turborepo uses pnpm as a packages manager. It includes the following packages/apps:

Apps

• frontend: The Next.js app
• backend: The FastAPI app

frontend is 100% TypeScript. backend is 100% Python

Utilities

This turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Setup

This repository is used in the pnpx create-turbo@latest command, and selected when choosing which package manager you wish to use with your monorepo (PNPM).

Build

To build all apps and packages, run the following command:

cd reponame
pnpm run build

Develop

To develop all apps and packages, run the following command:

cd reponame
pnpm run dev

Remote Caching

Turborepo can use a technique known as Remote Caching (Beta) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching (Beta) you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd reponame
pnpx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

pnpx turbo link

Useful Links

Learn more about the power of Turborepo:

• Pipelines
• Caching
• Remote Caching (Beta)
• Scoped Tasks
• Configuration Options
• CLI Usage