README.md

Welcome to SpaceYaTech Website Redesign!

---

Welcome to the SpaceYaTech website redesign project! This Readme provides comprehensive information about the project, including project description, project structure, communication channels, roadmap, license information, acknowledgments, and links to other important files.

---

Table of Contents

• Project Description
• Project Set Up
• Project Structure
• Communication Channels
• Roadmap
• License Information
• Acknowledgments
• Links to Other Important Files

Project Description

The SpaceYaTech website is being redesigned to enhance its user experience and visual appeal.

The new website will be built using the following tech stack:

• React: JavaScript library for building user interfaces.
• Vite: build tool that aims to provide a faster and leaner development experience for modern web projects.
• Tailwind CSS: utility-first CSS framework for rapidly building custom user interfaces.
• GitHub: platform for version control and collaboration.
• Figma: web-based vector graphics editor and prototyping tool.

Figma Design Reference: Figma Design

Project Set Up

Follow these steps to get the project up and running on your local machine:

1. Clone the repository

   Open your terminal and run the following command:

   git clone https://github.com/SpaceyaTech/SYT-Web-Redesign.git

2. Navigate into the directory

   Change your current directory to the project's directory:

   cd SYT-Web-Redesign

3. Install the dependencies

   Run the following command:

   npm install

4. Start the development server

   Now you can start the development server and begin developing:

   npm run dev

   The project should now be running at http://localhost:5173 (or another port if 5173 is already in use).

Project Structure

The project follows a standard directory structure:

.
├── docs
│   ├── CONTRIBUTING.md
│   ├── CODE_OF_CONDUCT.md
├── public
├── src
│   ├── api
│   ├── APP
│   │   ├── components
│   │   ├── pages
│   │   ├── index.js
│   ├── assets
│   │   ├── images
│   ├── context
│   ├── hooks
│   │   ├── Mutations
│   │   ├── Queries
│   │   ├── useAuth.jsx
│   ├── router
│   ├── utilities
│   └── ...
├── main.jsx
├── index.css
├── README.md
└── ...

• The public directory contains static assets like images, icons, etc.
• The src directory contains the main source code of the project, including components, pages, styles, and other related files.

Communication Channels

For effective collaboration and communication, we recommend the following channels:

• Discord Sever: Join the SpaceYaTech community on Discord.

• Rocket.Chat: Join the SpaceYaTech on Rocket.Chat platform. Share your Rocket.Chat username with the project maintainers to get an invitation.

• GitHub Discussions: Use GitHub Discussions for general discussions, feature requests, and questions related to the project.

• GitHub Issues: Use GitHub Issues to report bugs, track feature requests, and discuss specific issues related to the project.

Roadmap

The following roadmap outlines the planned milestones and features for the website redesign project:

1. Design planning and collaboration
2. Initial implementation of core pages
3. Integration of design assets
4. Styling and responsiveness
5. Content population and review
6. Performance optimization and testing
7. Final bug fixes and refinements

Please refer to the Roadmap page for more details.

License Information

The SpaceYaTech website redesign project is licensed under the Apache License. For more details, please refer to the LICENSE file.

Contributing

Please see our Contributing Guidelines for detailed information on how to contribute to the project.

Code of Conduct

We follow the . Please review it to understand our community standards and expected behavior.

Tech Stacks Used for Development:

Thank you for your interest and contributions to the SpaceYaTech website redesign project. Together, we can create an outstanding website experience!

Contributors