Prerequisites:
- Node Version Manager (NVM)
- Node.js v20.16.0
Note:
Docker is not needed for local development
Installation:
- Clone this project.
git clone [email protected]:Teamable-Analytics/teamable-frontend.git
- Create local environment file from sample.
cp sample.env .env
- Switch to the correct version of Node.js used in this project.
nvm use
- Start the development server.
yarn dev
- Open http://localhost:3000 with your browser to see the result.
Project setup:
- Follow the steps from Teamable Backend until you have an instructor signup token.
- Navigate to
http://localhost:3000/accounts/signup?token={{INSTRUCTOR_SIGNUP_TOKEN}}
, replacing{{INSTRUCTOR_SIGNUP_TOKEN}}
with the token from Step 1. - Signup with an email and password.
- Use a good password, the signup will fail if the password is weak.
- Once signed up, you will be redirected to the course's onboarding dashboard.
Loading components from shadcn/ui (Run this in root directory, where package.json is). Component names can be found here.
npx shadcn-ui@latest add component-name
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
- shadcn/ui - learn about shadcn/ui.
This is a Next.js project bootstrapped with create-next-app
.
This project uses next/font
to automatically optimize and load Inter, a custom Google Font.