Skip to content

Commit

Permalink
chore(docs): update markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
zakhaev26 committed Aug 28, 2024
1 parent 440755b commit e5fe9fc
Showing 1 changed file with 39 additions and 14 deletions.
53 changes: 39 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,45 @@
# C o u p o n - A g g r e g a t o r
A perfect coupon selling solution.
<h1 align="center">
Coupon Aggregator - Mobile App
<br>
</h1>

# Some - Glimpses of the App

<div align="center">
Service made to allow transactions of mess coupons between IIIT-Bh Students.

# F u n c t i o n i n g
App has several features including :
## 1.Authentication :
This app uses proper authentication and sign up features
Student can sell his/her coupon so that other peer can buy/purchase it.
<h3>P-Society Handles</h3>
<h3 align="center">
<a href="https://dev-psoc.netlify.app/">Website</a>
<span> | </span>
<a href="https://discord.gg/UhmKJGMnan">Community Discord</a>
<span> | </span>
<a href="https://github.com/p-society/gc-server/blob/main/docs/CONTRIBUTING.md">Contribute</a>
</h3>

## App Internals :
State Management : **MobX** </br>
Api handling : **Http**
</div>

# Run Locally
----------------------------------------
<div align="center">

**Coupon Aggregator** ensures effortless mess coupon listing, enhancing your experience with hassle-free and efficient listing in the app.The application is built using Feathers.js(v4) , MongoDB and Flutter.
</div>
<div align="center">
<br/>
<img src='https://skillicons.dev/icons?i=nodejs,mongodb,flutter' ></img>
<img src='https://github.com/p-society/raag/assets/119437069/5f30138e-fa76-4947-946e-603d2de1550f' width='50' height='50' style='border-radius: 10px;'>

# C o n t r i b u t i o n
Contribution are welcome. Feel free to ask any query regarding for any contribution.
</div>
<br/>


### Current contributors <a name="Current contributors"></a>

<a href="https://github.com/p-society/coupon-aggregator-client/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=p-society/coupon-aggregator-client" />
</a>

Made with [contributors-img](https://contributors-img.web.app).

# License <a name="License"></a>

GC-Server and GC-Client is licensed under [Apache License](https://github.com/p-society/coupon-aggregator-client/blob/master/LICENSE)

0 comments on commit e5fe9fc

Please sign in to comment.