Welcome to the X-Digitally Website client-side codebase. This project is built using React.js and is organized to ensure scalability and maintainability.
This project utilizes the following technologies:
- React.js β A JavaScript library for building user interfaces.
- Vite β A fast development build tool for modern web applications.
- Custom CSS β Handcrafted CSS for styling components.
- React Router β Declarative routing for React applications.
- Axios β Promise-based HTTP client for making API requests.
- ESLint & Prettier β Tools for maintaining code quality and formatting.
The client/src
directory is organized as follows:
src/ βββ assets/ # Images, fonts, and other static resources βββ components/ # Reusable UI components βββ fonts/ # Custom font files βββ App.css # Global CSS styles βββ App.js # Main application component βββ index.css # Global CSS styles βββ index.js # Application entry point
markdown Copy Edit
- assets/: Contains images, fonts, and other static resources.
- components/: Houses reusable UI components.
- fonts/: Stores custom font files used throughout the application.
- App.css: Global CSS styles applied across the application.
- App.js: The main application component that sets up the overall structure.
- index.css: Additional global CSS styles.
- index.js: The entry point of the React application, rendering the
App
component.
To set up the project locally, follow these steps:
git clone https://github.com/sarahmaheen/X-digitally-website.git
2οΈβ£ Navigate to the Client Directory
sh
Copy
Edit
cd X-digitally-website/client
3οΈβ£ Install Dependencies
Ensure you have Node.js installed. Then, run:
sh
Copy
Edit
npm install
This will install all necessary dependencies.
4οΈβ£ Run the Development Server
Start the development server with:
sh
Copy
Edit
npm run dev
This will launch the application, and you can view it in your browser at http://localhost:3000.
ποΈ Building for Production
To create an optimized production build, run:
sh
Copy
Edit
npm run build
This will generate the production-ready files in the build/ directory.
π€ Contributing
We welcome contributions to enhance this project. To contribute:
Fork the repository.
Create a new branch: git checkout -b feature/YourFeature.
Make your changes and commit them: git commit -m 'Add new feature'.
Push to the branch: git push origin feature/YourFeature.
Submit a pull request.
Please ensure your code adheres to the project's coding standards and includes relevant tests.
π License
This project is licensed under the MIT License. See the LICENSE file for details.