GymSciencx Web App

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

1. pnpm
2. Node.js

Installing

pnpm install

Developing

Start a development server:

pnpm run dev

# or start the server and open the app in a new browser tab
pnpm run dev -- --open

Building

To create a production version of your app:

pnpm run build

You can preview the production build with npm run preview.

Built With

• SvelteKit - Framework
• TailwindCSS - CSS
• TypeScript
• shadcn-svelte - UI components
• lucide-svelte - Icons

Some Guidelines

• After installation, duplicate the ".env.example" file and rename it to ".env".
• Please don't add new libraries without discussing it with the team first.
• Please don't make unnecessary changes in the lib/components/ui directory. That directory is being used by shadcn-svelte.
• If you want to create reusable components use the lib/components/reusable directory.
• The pages for the manager front of the web app are in the src/routes/(app) directory, similarly src/routes/(pages) is used for pages that are accessible to all, and src/routes/(auth) for authentication-related pages.
• Only +page.svelte/ts or +layout.svelte/ts files should be created inside the /routes directory, if the page is getting too big, create a directory inside src/lib/pages/ and then import those files in the main +page.svelte or +layout.svelte file.
• Please use <script lang="ts"> instead of <script> in svelte files.
• Please refrain from adding global styles.
• Types should be added in the src/lib/types directory.
• If the same styles are being used by multiple dom elements inside a single file and the class string is getting too long, use svelte-style-tag and use @apply for adding tailwind classes.