💫 lmsGenie Front-End 💫

This repository contains code and resources dedicated to the development and maintenance of the frontend component of the lmsGenie application. For UI design, we are adapting E-Tutor - Learning Management System Figma Design by Templatecookie which is licensed under CC BY 4.0.

Getting Started

Below steps will guide you, how to set up your project locally. To get a local copy up and running follow these simple example steps.

1. Install pnpm

npm i -g pnpm

2. Clone repo locally.

git clone https://github.com/lmsGenie/client.git

3. Install dependencies

pnpm i

4. Run project locally

pnpm run dev

Project Structure

1. Code files

• src/: Contains main source code
• src/app: Next.js app directory. Checkout Next.js Routing
• src/app/globals.css: Global CSS file.
• src/components: Contains UI components.
• src/components/ui: Contains shadcn/ui components. Checkout Shadcn/ui Components
• src/types: Contains Type definitions.
• src/sampledata: Contains sample data.

2. Assets files

• src/assets: Contains project assets (images, icons, etc.)
• public/: Next.js public directory. Checkout Next.js Routing
• public/sprite: Contains all svg icons. Checkout "How to use Sprite Icons"

3. Config files

• next.config.js: Next.js config.
• components.json: Shadcn config.
• .eslintrc.json: Eslint config.
• .eslintignore: Esline ignore.
• commitlint.config.js: Commitlint config.
• prettier.config.js: Prettier config.
• .prettierignore: Prettier ignore.
• tailwind.config.ts: Tailwind config.
• tsconfig.json: Typesctipt config.
• package.json: Project dependencies.

Want to contribute?

Feel like contributing? That's awesome! We have a contributing guide to help guide you.

Want to discuss something? Create a discussion