Welcome to the StuCo Frontend repository! This project is part of StuCo, a social platform connecting high school students with U.S. college students. This repository contains the code for the frontend interface, built using modern web technologies for an engaging and dynamic user experience.
- React: JavaScript library for building user interfaces.
- Tailwind CSS: Utility-first CSS framework for styling.
- Vite: Fast build tool for modern web projects.
- Node.js: Ensure you have Node.js installed (v16 or higher recommended).
- npm or yarn: You can use npm (comes with Node.js) or yarn as a package manager.
-
Clone the repository:
git clone https://github.com/StuCo-Official/Frontend.git
-
Navigate to the project directory:
cd Frontend -
Install dependencies:
npm install # or yarn install
To start the development server, run:
npm run dev
# or
yarn devThis will start the Vite server, and you can access the app at http://localhost:3000.
To build the frontend for production, use the following command:
npm run build
# or
yarn buildThis will create an optimized production build in the dist folder.
- src/: Main source code for the frontend.
- assets/: Static assets like images and icons.
- components/: Reusable React components.
- auth/: Components related to authentication (e.g., signup, login).
- layout/: Layout components (e.g., header, footer).
- posts/: Components related to posts and content.
- ui/: General UI components (e.g., buttons, modals).
- pages/: Application pages.
- styles/: Tailwind CSS styles and global styles.
- public/: Public assets.
- App.tsx: Main application component.
- index.css: Global CSS file.
- main.tsx: Entry point of the application.
- vite-env.d.ts: Vite environment type definitions.
We welcome contributions to StuCo! Please feel free to open issues or submit pull requests. Before submitting a pull request, make sure to:
- Create a new branch for your feature/fix.
- Follow the existing code style and conventions.
This project is licensed under the MIT License. See the LICENSE file for more details.
For any questions, please reach out to the StuCo team at contact@stuco.com.