Skip to content

πŸš€ X-Digitally Website - Client A React.js-based web application with Vite, React Router, and Axios, providing a scalable and maintainable front-end experience.

Notifications You must be signed in to change notification settings

sarahcodeland/X-digitally-website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 

Repository files navigation

X-Digitally Website - Client

Welcome to the X-Digitally Website client-side codebase. This project is built using React.js and is organized to ensure scalability and maintainability.

πŸš€ Technologies and Frameworks

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.

πŸ“‚ Project Structure

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.

πŸ› οΈ Installation & Setup

To set up the project locally, follow these steps:

1️⃣ Clone the Repository

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.

About

πŸš€ X-Digitally Website - Client A React.js-based web application with Vite, React Router, and Axios, providing a scalable and maintainable front-end experience.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published