Generocity
No description available
Install / Use
/learn @SMJC/GenerocityREADME
<!--
*** Thanks for checking out this README Template. If you have a suggestion that would
*** make this better, please fork the repo and create a pull request or simply open
*** an issue with the tag "enhancement".
*** Thanks again! Now go create something AMAZING! :D
-->
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
<!-- [![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url] -->
<!-- PROJECT LOGO -->
<br />
<p align="center">
<p align="center">
<img
alt="path-19 logo"
src="./assets/logo.png"
height="300"
/>
</p>
<p align="center">
A platform for giving
<br />
<!-- <a href="https://github.com/wellhaus/path-19.git"><strong>Docs coming soon!</strong></a> -->
<br />
<br />
<a href="https://github.com/SMJC/Generocity.git">Demo coming soon!</a>
·
<a href="https://github.com/SMJC/Generocity.git/issues">Report Bug</a>
·
<a href="https://github.com/SMJC/Generocity.git/issues">Request Feature</a>
</p>
</p>
<!-- TABLE OF CONTENTS -->
Table of Contents
<!-- * [Contact](#contact) * [Acknowledgements](#acknowledgements) --> <!-- ABOUT THE PROJECT -->About The Project
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->Generocity was created to connect those who have with those who need.
<!-- GETTING STARTED --> <!-- ### Prerequisites This is an example of how to list things you need to use the software and how to install them. * npm ```sh npm install npm@latest -g ``` -->Installation
- Fork the repo
- Clone the repo
git clone https://github.com/SMJC/Generocity.git
- Install NPM packages
npm install
- npm run dev
npm run dev
<!-- USAGE EXAMPLES -->
Usage
Local items are displayed on the landing page.
<br />
<br />
If you're interested in an item, message (beta) the item's owner.<br />
<br />
<br />
If you'd like to give an item, sign up for a free account.<br />
<br />
<br />
Roadmap
See the open issues for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.
