Skip to content

Teamable-Analytics/teamable-frontend

Repository files navigation

Teamable: Frontend

Getting Started

Prerequisites:

Installation:

  1. Clone this project.
     git clone [email protected]:Teamable-Analytics/teamable-frontend.git
  2. Create local environment file from sample.
    cp sample.env .env
  3. Switch to the correct version of Node.js used in this project.
    nvm use
  4. Start the development server.
    yarn dev
  5. Open http://localhost:3000 with your browser to see the result.

Project setup:

  1. Follow the steps from Teamable Backend until you have an instructor signup token.
  2. Navigate to http://localhost:3000/accounts/signup?token={{INSTRUCTOR_SIGNUP_TOKEN}}, replacing {{INSTRUCTOR_SIGNUP_TOKEN}} with the token from Step 1.
  3. Signup with an email and password.
    • Use a good password, the signup will fail if the password is weak.
  4. Once signed up, you will be redirected to the course's onboarding dashboard.

Useful commands

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

Resources

Appendix

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.

About

Teamable web application UI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published