Refactor README and adjust import paths after directory restructuring
The codebase has been optimised with a reorganisation of the component directories. This required modifications to some import paths to preserve functionality, notably in services.astro. The README file was also decluttered and reframed under development and deployment commands to improve new developer onboarding. These changes pave the way for better SEO performance and ease of extendibility.
This commit is contained in:
parent
09fc23fcdc
commit
38e8049299
3 changed files with 25 additions and 30 deletions
51
README.md
51
README.md
|
@ -1,4 +1,4 @@
|
|||
# ScrewFast: Landing Page/Blog Template
|
||||
# ScrewFast: Simplified Landing & Blog Template
|
||||
|
||||

|
||||
|
||||
|
@ -22,11 +22,7 @@ ScrewFast is a landing and blog template crafted with simplicity and ease of use
|
|||
|
||||
## Getting Started
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
This guide will help you set up the Astro project on your local machine and introduce you to some essential commands for development and deployment.
|
||||
</summary>
|
||||
<br>
|
||||
|
||||
### Installation
|
||||
|
||||
|
@ -38,36 +34,35 @@ npm install
|
|||
|
||||
This command will install all the dependencies listed in the project's `package.json` file.
|
||||
|
||||
### Common Commands
|
||||
### Development Commands
|
||||
|
||||
Once the installation is completed, you can use various npm scripts defined in `package.json` to manage the development lifecycle of your project:
|
||||
After installing the dependencies, you can use these npm scripts for the development lifecycle of your project:
|
||||
|
||||
- `npm run dev`: Launches a local server with hot reloading.
|
||||
- `npm run preview`: Previews the build locally.
|
||||
- `npm run astro`: Executes Astro CLI commands.
|
||||
- `npm run astro --help`: Provides help information for Astro commands.
|
||||
|
||||
Learn more about Astro's CLI by referring to [Astro's documentation](https://docs.astro.build/).
|
||||
|
||||
## Deployment
|
||||
|
||||
### Building Your Site
|
||||
|
||||
Before deployment, you need to create a production build:
|
||||
|
||||
```bash
|
||||
# Starts the local development server
|
||||
|
||||
npm run dev
|
||||
|
||||
# Builds your production site and outputs it to ./dist/
|
||||
|
||||
npm run build
|
||||
|
||||
# Previews your built site locally before deploying it
|
||||
|
||||
npm run preview
|
||||
|
||||
# Runs Astro CLI commands such as astro add or astro check
|
||||
|
||||
npm run astro
|
||||
|
||||
# Displays help information for Astro CLI commands
|
||||
|
||||
npm run astro --help
|
||||
```
|
||||
|
||||
### Learning More
|
||||
This creates a `dist/` directory with your built site (configurable via [outDir in Astro](https://docs.astro.build/en/reference/configuration-reference/#outdir)).
|
||||
|
||||
To learn more about the available Astro CLI commands and further understand the capabilities of Astro, refer to [Astro's documentation](https://docs.astro.build/).
|
||||
</details>
|
||||
### Deploying to Vercel
|
||||
|
||||
To deploy ScrewFast to Vercel, follow these steps:
|
||||
|
||||
1. Clone this repository to your GitHub account.
|
||||
2. Click the button below to start deploying your forked copy on Vercel:
|
||||
|
||||
## Project Structure
|
||||
|
||||
|
|
|
@ -13,7 +13,7 @@ const benefits: string[] = [
|
|||
"Innovative solutions tailored to modern construction needs.",
|
||||
"Customer support dedicated to your project's success.",
|
||||
];
|
||||
|
||||
// Define SVG marker to be used in the component
|
||||
const ListItemMarker: string = `<svg fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="mt-0.5 h-6 w-6 text-[#fa5a15] dark:text-[#fb713b]"><path stroke-linecap="round" stroke-linejoin="round" d="M9 12.75 11.25 15 15 9.75M21 12a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"/></svg>`;
|
||||
---
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ import MainLayout from "../layouts/MainLayout.astro";
|
|||
import MainSection from "../components/ui/blocks/MainSection.astro";
|
||||
import LeftSection from "../components/ui/blocks/LeftSection.astro";
|
||||
import RightSection from "../components/ui/blocks/RightSection.astro";
|
||||
import FeaturesStats from "../components/sections/FeaturesStats.astro";
|
||||
import FeaturesStats from "../components/sections/features/FeaturesStats.astro";
|
||||
|
||||
// Import necessary images
|
||||
import blueprints from "../images/blueprints-image.avif";
|
||||
|
|
Loading…
Add table
Reference in a new issue