{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Setup","type":"text"}]},{"type":"paragraph","content":[{"text":"Planner requires ","type":"text"},{"text":"Node v16+","type":"text","marks":[{"type":"link","attrs":{"href":"https://nodejs.org/en/"}}]},{"text":" and ","type":"text"},{"text":"Python3.10","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.python.org/downloads"}}]},{"text":". It also requires local environment variables since it uses ","type":"text"},{"text":"Neon","type":"text","marks":[{"type":"link","attrs":{"href":"https://neon.tech"}}]},{"text":" (hosted PostgresDB service), a SMTP server, and Discord as authentication provider.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Pre-requisites","type":"text"}]},{"type":"paragraph","content":[{"text":"To be able to start development on Planner make sure that you have the following pre-requisites installed:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Node.js v16 or above","type":"text","marks":[{"type":"link","attrs":{"href":"https://nodejs.org/en"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Git","type":"text","marks":[{"type":"link","attrs":{"href":"https://git-scm.com/downloads"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Python3.11","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.python.org/downloads"}}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Installation and Configuration","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Clone repository and install web dependencies:","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"git clone https://github.com/UTDNebula/planner.git\ncd planner\nnpm install","type":"text"}]},{"type":"orderedList","attrs":{"order":2},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy ","type":"text"},{"text":".env.example file","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":".env","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"paragraph","content":[{"text":"Copy the contents of the ","type":"text"},{"text":".env.example","type":"text","marks":[{"type":"code"}]},{"text":" file at the root of the repo to a new file called ","type":"text"},{"text":".env","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Setting up Neon:","type":"text"}]},{"type":"paragraph","content":[{"text":"Neon is a hosting service for PostgreSQL.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install the ","type":"text"},{"text":"Neon CLI","type":"text","marks":[{"type":"link","attrs":{"href":"https://neon.tech/docs/reference/cli-install"}}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run ","type":"text"},{"text":"neonctl auth","type":"text","marks":[{"type":"code"}]},{"text":" and follow the on-screen prompts to login or create an account.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run ","type":"text"},{"text":"neonctl projects create --name planner-dev","type":"text","marks":[{"type":"code"}]},{"text":" to create a Neon project for Planner.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy the string listed under 'Connection Uri' (ex: ","type":"text"},{"text":"postgres://my-user:my-password@my-project-id.us-east-2.aws.neon.tech/neondb","type":"text","marks":[{"type":"code"}]},{"text":") and update the ","type":"text"},{"text":"DATABASE_URL","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"DIRECT_DATABASE_URL","type":"text","marks":[{"type":"code"}]},{"text":" variables in your ","type":"text"},{"text":".env","type":"text","marks":[{"type":"code"}]},{"text":" file, as shown below.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"# Prisma\nDATABASE_URL=\"\"\nDIRECT_DATABASE_URL=\"\"","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Apply database migrations:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"npx prisma migrate dev","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Request ","type":"text"},{"text":"PLATFORM_DATABASE_URL","type":"text","marks":[{"type":"code"}]},{"text":" from someone on the team.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the ","type":"text"},{"text":"NEXTAUTH_URL","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"http://localhost:3000","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"NEXTAUTH_SECRET","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"abc123","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Setting up an auth provider. You need at least one of these to log in. ","type":"text"},{"text":"We recommend you only add Discord for convenience","type":"text","marks":[{"type":"underline"}]},{"text":".","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Add Discord Authentication"},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to Discord Developer Portal — My Applications","type":"text","marks":[{"type":"link","attrs":{"href":"https://discord.com/developers/applications"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on New Application","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"f57ab3a8-dd82-4a28-9764-bd1c21a0eb5b","collection":"contentId-34832554","type":"file","height":627}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Type \"planner\"","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"f4219954-4f9a-4468-83a0-90e3e085f9d4","collection":"contentId-34832554","type":"file","height":627}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Agree to their terms of service","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"72224524-e140-4172-8645-aeb5f0c3f036","collection":"contentId-34832554","type":"file","height":627}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click to create","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"114fba02-3ca7-4550-af40-bb951c92d736","collection":"contentId-34832554","type":"file","height":627}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on OAuth2","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"400ab926-7ac0-4b0e-8d96-253e7a6ebb2a","collection":"contentId-34832554","type":"file","height":627}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on reset the secret ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"2c505228-fda7-49ab-b660-c78691e1e7a5","collection":"contentId-34832554","type":"file","height":627}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on \"Yes, do it!\" and copy the generated secret","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"a9ae5cca-a904-4fc4-8d94-e31242878487","collection":"contentId-34832554","type":"file","height":627}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on \"Add Redirect\"","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"cccbcf35-ffe8-4e52-843f-80d554e7170b","collection":"contentId-34832554","type":"file","height":627}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Paste \"","type":"text"},{"text":"http://localhost:3000/api/auth/callback/discord\"","type":"text","marks":[{"type":"link","attrs":{"href":"http://localhost:3000/api/auth/callback/discord%22"}}]},{"text":" into input","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"ffdd5e17-63d5-4a37-a06d-62e18e89a592","collection":"contentId-34832554","type":"file","height":627}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on save changes at the bottom","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"62e4e5bf-1f8b-4023-bd1d-b9a41be46242","collection":"contentId-34832554","type":"file","height":627}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy and paste your secret and clientID (also on the OAuth2 page) into your ","type":"text"},{"text":".env","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":" # Next Auth Discord Provider\n DISCORD_CLIENT_ID=\n DISCORD_CLIENT_SECRET=","type":"text"}]}]}]}]},{"type":"expand","attrs":{"title":"Add Email Magic Link Authentication"},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to Mailtrap: Email Delivery Platform","type":"text","marks":[{"type":"link","attrs":{"href":"https://mailtrap.io/"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on Sign up for free and create your account
","type":"text"},{"type":"hardBreak"},{"text":"

","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on Start Testing
","type":"text"},{"type":"hardBreak"},{"text":"

","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on Nodemailer
","type":"text"},{"type":"hardBreak"},{"text":"

","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy the host, port, user, and pass values.","type":"text"}]}]}]}]},{"type":"orderedList","attrs":{"order":7},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run and configure validator","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a virtual environment:","type":"text"}]},{"type":"codeBlock","content":[{"text":"cd validator\npython3.11 -m venv venv # Create virtual environment","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Activate the virtual environment:","type":"text"},{"type":"hardBreak"},{"text":"- Windows: ","type":"text"},{"text":"venv\\Scripts\\activate","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"- Linux/macOS: ","type":"text"},{"text":"source venv/bin/activate","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install dependencies:","type":"text"}]},{"type":"codeBlock","content":[{"text":"pip install -r requirements.txt","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run the validator:","type":"text"}]},{"type":"codeBlock","content":[{"text":"flask --app api run","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the validator to ","type":"text"},{"text":".env","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"# DEGREE VALIDATOR\nNEXT_PUBLIC_VALIDATOR=http://127.0.0.1:5000","type":"text"}]}]}]}]}]},{"type":"orderedList","attrs":{"order":8},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For any unused variables in your ","type":"text"},{"text":".env","type":"text","marks":[{"type":"code"}]},{"text":" file, just leave them blank.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Generate ","type":"text"},{"text":"Prisma","type":"text","marks":[{"type":"code"}]},{"text":" client and run web server:","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"# Run these in the root directory.\nnpm run prisma:generate\nnpm run dev","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview of the tech stack: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://nebula-labs.atlassian.net/wiki/spaces/NP/pages/35258369"}},{"text":".","type":"text"}]}],"version":1}

Browser not supported