Virtue Movement Website Project

🔍 Table of Contents

• 💻 Stack

• 📝 Project Summary

• ⚙️ Setting Up

• 🚀 Run Locally

• 🙌 Contributors

• 📄 License

💻 Stack

• shadcn/ui: Beautifully designed components built with Radix UI and Tailwind CSS.
• clerk/nextjs: Authentication and user management.
• fullcalendar/react: Timetable component for displaying events.
• hookform/resolvers: Resolvers for form validation.
• radix-ui/react-icons: Collection of icons for UI components.
• tanstack/react-table: Data table component for displaying and managing tabular data.
• next: Framework for building server-side rendered React applications.
• react: JavaScript library for building user interfaces.
• tailwindcss: Utility-first CSS framework for styling components.

📝 Project Summary

• .github: GitHub workflows for CI/CD automation.
• components: Reusable UI components for building the application.
• lib: Utility libraries or modules used throughout the project.
• pages: Main pages of the application, including admin and student pages.
• pages/admin: Admin-related pages such as data tables.
• pages/booking: Booking-related pages for adding and managing bookings.
• pages/students: Student-related pages for adding managing student data.
• prisma: Database ORM migrations and models for data manipulation.
• public: Publicly accessible assets and static files.
• styles: Global stylesheets and CSS modules for styling the application.

Note: The directories are listed in alphabetical order.

⚙️Environment Variables

• DATABASE_URL: URL for the postgres database
• DIRECT_URL: Direct url of the database for dev jobs
• CLERK_SECRET_KEY: Clerk private API key
• RESEND_API_KEY: Resend api key for sending emails
• NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY: Clerk public API key
• NEXTPUBLIC_CLERK...: Environmental variables for defining clerk behavior

🚀 Run Locally

0. Install Node.js

1.Clone the virtue-gymnastics-website repository:

git clone https://github.com/RCNOverwatcher/virtue-gymnastics-website

2.Install the dependencies:

npm install

3.Start the development mode:

npm run dev

🙌 Contributors

RCNOverwatcher All of the contributions

📄 License

This project is licensed under the MIT License - see the MIT License file for details.