Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SanjanaSogimatt committed Dec 8, 2024
1 parent caee6f4 commit f4f4993
Showing 1 changed file with 30 additions and 105 deletions.
135 changes: 30 additions & 105 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,123 +1,48 @@
<h1 align=center>Pinwheel Astro</h1>
<p align=center>Pinwheel is a free multipurpose SaaS theme built with Astro, TailwindCSS and TypeScript with 17+ pre-designed pages.</p>
<h2 align="center"><a target="_blank" href="https://pinwheel-astro.vercel.app/" rel="nofollow"> 👀 Demo</a> | <a target="_blank" href="https://pagespeed.web.dev/analysis/https-pinwheel-astro-vercel-app/kmaxqwa7rx?form_factor=desktop"> Page Speed (95+) 🚀 </a>
</h2>
# AMRIT (Accessible Medical Records via Integrated Technologies)
<p align=center>
<a href="https://github.com/withastro/astro/releases/tag/astro%404.3.2" alt="Contributors">
<img src="https://img.shields.io/static/v1?label=ASTRO&message=4.3&color=000&logo=astro" />
</a>

<a href="https://github.com/themefisher/pinwheel-astro/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/themefisher/pinwheel-astro" alt="license"></a>

<img src="https://img.shields.io/github/languages/code-size/themefisher/pinwheel-astro" alt="code size">

<a href="https://github.com/themefisher/pinwheel-astro/graphs/contributors">
<img src="https://img.shields.io/github/contributors/themefisher/bigspring-light-astro" alt="contributors"></a>
AMRIT is a cutting-edge health technology platform designed to revolutionize healthcare in India. Developed by Piramal Swasthya, AMRIT is integrated with the Ayushman Bharat Digital Mission (ABDM), supporting the creation and verification of Ayushman Bharat Health Accounts (ABHA). The platform enables patient consent-based access to medical history, promoting a unified health data presence nationwide.
</p>

![pinwheel](https://demo.themefisher.com/thumbnails/pinwheel.png)

<!-- small description -->

<!-- key features -->
## 📌 Key Features

- 📄 17+ Pre-designed pages
- 🎨 Highly customizable (Color, Font, Menu, Social Links, SEO Meta Tags, etc.)
- 🗃️ Taxonomy support
- ⚡ Fast by default (95+ Google PageSpeed Score)
- 🔧 Netlify setting pre-configured
- 📝 Contact form support
- 🖼️ Support OG image
- 📝 Write and update content in Markdown / MDX
- 💻 MDX components auto import
- 📝 Includes draft pages and posts
- 🎨 Built with Tailwind CSS framework
- 📱 Fully responsive on desktops, tablets, and smartphones
- 🔍 SEO Friendly
- 💬 Disqus comment support

## 📄 17+ Pre-Designed Pages

- 🏠 Home
- 🛠️ How it works
- 🌟 Features
- 📝 Blog
- 📝 Blog Single
- 🗂️ Categories
- 🗂️ Category Single
- 👤 About
- 📞 Contact
- 💼 Career
- 💼 Career Single
- 💰 Pricing
- 📜 Changelog
- 🔑 Sign In
- 🔑 Sing Up
- 🔗 Integrations
- 🔗 Integration Single
- 📜 Terms and Conditions
- 💡 Elements

<!-- installation -->
## 🛠️ Installation

After downloading the template, you have some prerequisites to install. Then you can run it on your localhost. You can view the package.json file to see which scripts are included.

### Install prerequisites (once for a machine)

- **Node Installation:** [Install node js](https://nodejs.org/en/download/) [Recommended LTS version]

### 👨🏻‍💻 Local setup

After successfully installing those dependencies, open this template with any IDE [[VS Code](https://code.visualstudio.com/) recommended], and then open the internal terminal of IDM [vs code shortcut <code>ctrl/cmd+\`</code>]

- 👉 Install dependencies

```
npm install
```

- 👉 Run locally

```
npm run dev
```

After that, it will open up a preview of the template in your default browser, watch for changes to source files, and live-reload the browser when changes are saved.
## How to Run Locally

## 🏗️ Production Build
1. Clone the repository:

After finishing all the customization, you can create a production build by running this command.
```bash
git clone https://github.com/AMRIT-Website/AMRIT.git
cd AMRIT
```

```
npm run build
```
2. Install dependencies:

<!-- reporting issue -->
## 🐞 Reporting Issues
```bash
npm install
```

We use GitHub Issues as the official bug tracker for this Template. Please Search [existing issues](https://github.com/themefisher/pinwheel-astro/issues). It’s possible someone has already reported the same problem.
If your problem or idea has not been addressed yet, feel free to [open a new issue](https://github.com/themefisher/pinwheel-astro/issues).
3. Start the development server:

<!-- licence -->
## 📝 License
```bash
npm run dev
```

Copyright (c) 2023 - Present, Designed & Developed by [Themefisher](https://themefisher.com)
4. Open the application in your browser at `http://localhost:4321/`.

**Code License:** Released under the [MIT](https://github.com/themefisher/pinwheel-astro/blob/main/LICENSE) license.

**Image license:** The images are only for demonstration purposes. They have their license, we don't have permission to share those images.
## Contribution Guidelines

## 💻 Need Custom Development Services?
We welcome contributions to enhance AMRIT! To get started:

Besides developing beautifully designed and blazing-fast themes, we help businesses create fast, performance-focused, scalable & secure websites based on NextJs, Hugo, Astro, etc.
1. Fork the repository.
2. Create a new branch for your feature/bugfix.
3. Commit your changes with clear and descriptive messages.
4. Push your branch and create a Pull Request.
5. Engage with reviewers to address feedback and finalize the changes.

If you need a custom theme, theme customization, or complete website development services from scratch you can [Hire Us](https://themefisher.com/contact).
### How You Can Contribute

## 🔥 More Astro Themes By Themefisher
- **Bug Reports**: Report issues or suggest enhancements via GitHub Issues.
- **Feature Suggestions**: Propose new features or improvements.
- **Code Contributions**: Submit pull requests for bug fixes, new features, or documentation improvements.
- **Testing**: Help improve testing coverage by writing new tests or reporting test failures.
- **Community Support**: Answer questions or assist others in using and contributing to AMRIT.

| [![Bigpsring](https://demo.gethugothemes.com/thumbnails/bigspring.png)](https://themefisher.com/products/bigspring-light-astro) | [![Andromeda](https://demo.gethugothemes.com/thumbnails/andromeda.png)](https://themefisher.com/products/andromeda-astro) | [![Bookwrom](https://demo.gethugothemes.com/thumbnails/bookworm.png)](https://themefisher.com/products/bookworm-astro) |
|:---:|:---:|:---:|
| **Bigpsring Light**| **Andromeda** | **Bookwom Light** |

0 comments on commit f4f4993

Please sign in to comment.