Skip to content

Commit

Permalink
updated README.md (#112)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jinx-vi-0
jinx-vi-0 authored May 13, 2024
1 parent 90d81d2 commit ca17177
Showing 1 changed file with 110 additions and 38 deletions.
148 changes: 110 additions & 38 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,60 +1,132 @@
<div align="center">

# Nest ONDC Project
<img src="./Images/WebsiteImg.png">

</div>

<div align = "center">
<br>

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

<table align="center">
<thead align="center">
<tr border: 1px;>
<td><b>🌟 Stars</b></td>
<td><b>🍴 Forks</b></td>
<td><b>🐛 Issues</b></td>
<td><b>🔔 Open PRs</b></td>
<td><b>🔕 Close PRs</b></td>
</tr>
</thead>
<tbody>
<tr>
<td><img alt="Stars" src="https://img.shields.io/github/stars/MAVRICK-1/e-commerce_website?style=flat&logo=github"/></td>
<td><img alt="Forks" src="https://img.shields.io/github/forks/MAVRICK-1/e-commerce_website?style=flat&logo=github"/></td>
<td><img alt="Issues" src="https://img.shields.io/github/issues/MAVRICK-1/e-commerce_website?style=flat&logo=github"/></td>
<td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/MAVRICK-1/e-commerce_website?style=flat&logo=github"/></td>
<td><img alt="Close Pull Requests" src="https://img.shields.io/github/issues-pr-closed/MAVRICK-1/e-commerce_website?style=flat&color=critical&logo=github"/></td>
</tr>
</tbody>
</table>
</div>

## Project Description

Our project is an ONDC (Open Network for Digital Commerce) site integrated with OpenStreetMap. The aim is to provide a seamless digital commerce experience for businesses and consumers across Bharat. The platform leverages ONDC APIs for data exchange and integration with various digital commerce services.

- YouTuBe Video Link : [NestOndc](https://www.youtube.com/watch?v=-WzV5HD6KMo)
### Additional Resources:
- **YouTube Video Link:** [NestOndc](https://www.youtube.com/watch?v=-WzV5HD6KMo)
- **Deployment Link:** [Link](https://nestondc.vercel.app/)


- Deployment Link : [Link](https://nestondc.vercel.app/)
<div align="center">

## -> Key Features <-
</div>

## Features
- Integration with ONDC APIs
- OpenStreetMap integration for location-based services
- Full-stack development for seamless user experience
- Responsive frontend design for accessibility across devices
- Secure backend architecture for data management
- **Integration with ONDC APIs:** Seamless integration with ONDC APIs for enhanced functionality.
- **OpenStreetMap Integration:** Utilizes OpenStreetMap for accurate and reliable location-based services.
- **Full-stack Development:** Developed using a full-stack approach to ensure a seamless user experience from frontend to backend.
- **Responsive Frontend Design:** Designed with responsiveness in mind, ensuring accessibility across various devices and screen sizes.
- **Secure Backend Architecture:** Built with a secure backend architecture to ensure the safety and integrity of user data.

## Technologies Used
- Frontend: HTML, CSS, JavaScript, React.js, Redux
- Backend: Node.js, Express.js, Firebase Realtime Database
- Mapping: OpenStreetMap API
- Version Control: Git, GitHub

<div align="center">

## 💻 Tech Stacks

![HTML](https://img.shields.io/badge/HTML-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![CSS](https://img.shields.io/badge/CSS-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)
![JavaScript](https://img.shields.io/badge/JavaScript-%23F7DF1E.svg?style=for-the-badge&logo=javascript&logoColor=black)
![React.js](https://img.shields.io/badge/React.js-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
![Redux](https://img.shields.io/badge/Redux-%23764ABC.svg?style=for-the-badge&logo=redux&logoColor=white)
![Node.js](https://img.shields.io/badge/Node.js-%23339933.svg?style=for-the-badge&logo=node.js&logoColor=white)
![Express.js](https://img.shields.io/badge/Express.js-%23000000.svg?style=for-the-badge&logo=express&logoColor=white)
![Firebase Realtime Database](https://img.shields.io/badge/Firebase_Realtime_Database-%23FFA000.svg?style=for-the-badge&logo=firebase&logoColor=white)
![OpenStreetMap API](https://img.shields.io/badge/OpenStreetMap_API-%23767676.svg?style=for-the-badge&logo=openstreetmap&logoColor=white)
![Git](https://img.shields.io/badge/Git-%23F05032.svg?style=for-the-badge&logo=git&logoColor=white) ![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)

</div>

## Installation
1. Clone the repository: git clone <[https://github.com/USER_NAME/e-commerce_website.git](https://github.com/MAVRICK-1/e-commerce_website.git)>
2. Navigate to the project directory: cd <e-commerce_website>
3. Install dependencies: npm install
4. Run the development server: npm start
1. **Clone the repository:**
```bash
git clone https://github.com/MAVRICK-1/e-commerce_website.git
```
2. **Navigate to the project directory:**
```bash
cd e-commerce_website
```
3. **Install dependencies:**
```bash
npm install
```
4. **Run the development server:**
```bash
npm start
```

## Usage
- Access the ONDC platform through the provided URL.
- Explore the digital commerce services and features.
- Use the integrated OpenStreetMap for location-based services.
- Interact with the platform to experience seamless digital commerce.
- **Access the ONDC platform:** Use the provided URL to access the platform.
- **Explore digital commerce services:** Navigate through various features and services offered.
- **Utilize location-based services:** Take advantage of the integrated OpenStreetMap for location-based functionalities.
- **Interact with the platform:** Engage with the website to experience seamless digital commerce.

## Contributing
- Fork the repository.
- Create your feature branch: git checkout -b feature-name
- Commit your changes: git commit -am 'Add some feature'
- Push to the branch: git push origin feature-name
- Submit a pull request.

## 🤝 Our Contributors
Thank you for considering contributing to our project! To contribute, follow these steps:

1. **Fork the repository:** Click on the "Fork" button on the top right corner of the repository page.
2. **Create your feature branch:**
```bash
git checkout -b feature-name
```
Replace `feature-name` with a descriptive name for your feature.
3. **Commit your changes:**
```bash
git commit -am 'Add some feature'
```
4. **Push to the branch:**
```bash
git push origin feature-name
```
5. **Submit a pull request:** Once you have pushed your changes to your forked repository, go to the original repository and click on the "New pull request" button. Fill out the necessary information and submit your pull request.

<details>
<summary>Contributors</summary>
<div>
<a href="https://github.com/MAVRICK-1/e-commerce_website/graphs/contributors">
<img src="https://contrib.rocks/image?repo=MAVRICK-1/e-commerce_website"/>
</a>
</div>
</details>
#### We appreciate your contributions and will review your pull request as soon as possible. Thank you for helping to improve our project!

Thank you for your interest in contributing to our project! We appreciate any contributions, whether it's bug fixes, new features, or documentation improvements.

We value the time and effort you put into contributing, and we look forward to reviewing and merging your contributions. Join us on this exciting journey of creativity and collaboration, and let your projects shine on NestOndc!

<h2 align = "center"> 🤝 Our Contributors</h2>
<div align = "center">

![Contributors](https://contrib.rocks/image?repo=MAVRICK-1/e-commerce_website)

<h3>Thank you for contributing to our repository</h3>

</div>
<br>
<div align=center>
<h2>This Project is the part of</h2>
<img alt="GSSoC" src="https://raw.githubusercontent.com/GirlScriptSummerOfCode/MentorshipProgram/master/GSsoc%20Type%20Logo%20Black.png#gh-light-mode-only" width=87%>
Expand All @@ -67,4 +139,4 @@ This project is licensed under the [MIT License](LICENSE).
## Acknowledgements
We extend our heartfelt gratitude to the organizers of GSSOC for offering this invaluable platform to exhibit our talents and make meaningful contributions to the open-source community. Your efforts in fostering a collaborative environment for budding developers are commendable, and we are privileged to be a part of such an esteemed event. Thank you for providing us with the opportunity to showcase our skills and contribute to the advancement of open-source technology.

:star: Don't forget to give us a star! :star:
<h2 align="center">Don't forget to give us a ⭐</h2>

0 comments on commit ca17177

Please sign in to comment.