summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorManurbhav2024-04-27 22:56:29 +0530
committerManurbhav2024-04-27 22:56:29 +0530
commit5823311e3a3c2d18e8a624cd368fd9024db5abfa (patch)
treec27e58fc002ae68a2bde242ef245b29a370eb109
parentcef251971a95ca2aaff4568c179bdcb6f91ef923 (diff)
downloadIotJS-Astro-5823311e3a3c2d18e8a624cd368fd9024db5abfa.tar.gz
IotJS-Astro-5823311e3a3c2d18e8a624cd368fd9024db5abfa.tar.bz2
IotJS-Astro-5823311e3a3c2d18e8a624cd368fd9024db5abfa.zip
Update README.md
-rw-r--r--README.md81
1 files changed, 54 insertions, 27 deletions
diff --git a/README.md b/README.md
index 1db3fb3..3e04f4d 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,14 @@
-# Astro Starter Kit: Basics
+# Converting Static Website to Astro Framework: Documentation
-```sh
-npm create astro@latest -- --template basics
-```
-
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
-[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
+This project aims to convert a static website into the Astro framework, leveraging Astro's modern static site generation capabilities for improved performance, maintainability, and responsiveness.
-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+## Introduction
-![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
+The provided static website has been converted into the Astro framework, utilizing HTML, CSS (Bootstrap/Tailwind), and Vanilla JavaScript. The conversion process involved refactoring the codebase into reusable Astro components, implementing responsive design principles, and optimizing performance using Astro's features.
## 🚀 Project Structure
-Inside of your Astro project, you'll see the following folders and files:
+Inside of project, you'll see the following folders and files:
```text
/
@@ -22,33 +16,66 @@ Inside of your Astro project, you'll see the following folders and files:
│ └── favicon.svg
├── src/
│ ├── components/
-│ │ └── Card.astro
+│ │ └── Accordion.astro
+│ │ └── Carousel.astro
+│ │ └── Footer.astro
+│ │ └── Header.astro
+│ │ └── HomeBody.astro
+│ │ └── IconBar.astro
+│ │ └── Navbar.astro
+│ │ └── ResourcesBody.astro
+│ │ └── ScheduleBody.astro
+│ │ └── TopBar.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
+│ └── resources.astro
+│ └── schedule.astro
+└── .gitignore
+└── astro.config.mjs
└── package.json
+└── README.md
+```
+
+## Setup Instructions
+
+To run the project locally, follow these steps:
+
+1. Clone the repository using the following command:
+
+```bash
+git clone https://github.com/mannubhai1/Fossee.git
```
-Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
+## Navigate to the project directory:
+
+```bash
+cd FOSSEE
+```
+
+## Install dependencies:
+
+```bash
+npm install
+```
+
+## Start the development server:
+
+```bash
+npm run dev
+```
-There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
+### Open your browser and navigate to http://localhost:4321 to view the converted website.
-Any static assets, like images, can be placed in the `public/` directory.
+## Deployment
-## 🧞 Commands
+The converted website has been deployed using Netlify and is accessible via the following URL:
-All commands are run from the root of the project, from a terminal:
+## License
-| Command | Action |
-| :------------------------ | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:4321` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro -- --help` | Get help using the Astro CLI |
+This project is licensed under the MIT License.
-## 👀 Want to learn more?
+## Challenges Faced
-Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
+Adapting the navbar, accordion, and carousel components for mobile responsiveness proved challenging, as reliance on pre-made templates from Bootstrap and Tailwind was not viable within the Astro framework. Designing these components from scratch required extensive time and effort, especially as I lacked prior experience in creating responsive designs independently.