Skip to content

Commit e544ee1

Browse files
Revise README structure and enhance content
Updated README.md to improve structure and content.
1 parent 6ed40c5 commit e544ee1

File tree

1 file changed

+206
-1
lines changed

1 file changed

+206
-1
lines changed

README.md

Lines changed: 206 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,206 @@
1-
# hustle-android
1+
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
2+
<a id="readme-top"></a>
3+
<!--
4+
*** Thanks for checking out the Best-README-Template. If you have a suggestion
5+
*** that would make this better, please fork the repo and create a pull request
6+
*** or simply open an issue with the tag "enhancement".
7+
*** Don't forget to give the project a star!
8+
*** Thanks again! Now go create something AMAZING! :D
9+
-->
10+
11+
12+
13+
<!-- PROJECT SHIELDS -->
14+
<!--
15+
*** I'm using markdown "reference style" links for readability.
16+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
17+
*** See the bottom of this document for the declaration of the reference variables
18+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
19+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
20+
-->
21+
[![Contributors][contributors-shield]][contributors-url]
22+
[![Forks][forks-shield]][forks-url]
23+
[![Stargazers][stars-shield]][stars-url]
24+
[![Issues][issues-shield]][issues-url]
25+
[![project_license][license-shield]][license-url]
26+
[![LinkedIn][linkedin-shield]][linkedin-url]
27+
28+
29+
30+
<!-- PROJECT LOGO -->
31+
<br />
32+
<div align="center">
33+
<a href="https://github.com/cuappdev/hustle-android">
34+
<!-- <img src="images/logo.png" alt="Logo" width="80" height="80"> -->
35+
</a>
36+
37+
<h3 align="center">Hustle</h3>
38+
39+
<p align="center">
40+
A central service marketplace, exclusively for Cornell students. Built for students looking to save money—and for those hustling, freelancing, or launching a business.
41+
<br />
42+
<a href="https://www.notion.so/cornellappdev/Hustle-2600e873f4fa802d9ef7f052b92ff9ed"><strong>Explore the docs »</strong></a>
43+
<br />
44+
<br />
45+
<a href="https://github.com/cuappdev/hustle-android">View Demo</a>
46+
&middot;
47+
<a href="https://github.com/cuappdev/hustle-android/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
48+
&middot;
49+
<a href="https://github.com/cuappdev/hustle-android/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
50+
</p>
51+
</div>
52+
53+
54+
55+
<!-- TABLE OF CONTENTS -->
56+
<details>
57+
<summary>Table of Contents</summary>
58+
<ol>
59+
<li>
60+
<a href="#about-the-project">About The Project</a>
61+
<ul>
62+
<li><a href="#built-with">Built With</a></li>
63+
</ul>
64+
</li>
65+
<li>
66+
<a href="#getting-started">Getting Started</a>
67+
<ul>
68+
<li><a href="#prerequisites">Prerequisites</a></li>
69+
<li><a href="#installation">Installation</a></li>
70+
</ul>
71+
</li>
72+
<li><a href="#usage">Usage</a></li>
73+
<li><a href="#roadmap">Roadmap</a></li>
74+
<li><a href="#contributing">Contributing</a></li>
75+
<li><a href="#license">License</a></li>
76+
<li><a href="#contact">Contact</a></li>
77+
</ol>
78+
</details>
79+
80+
81+
82+
<!-- ABOUT THE PROJECT -->
83+
## About The Project
84+
85+
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
86+
87+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
88+
89+
90+
91+
### Built With
92+
93+
* ![Kotlin][Kotlin Badge]
94+
* ![Jetpack Compose][Jetpack Compose Badge]
95+
* ![Firebase][Firebase Badge]
96+
97+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
98+
99+
100+
101+
<!-- GETTING STARTED -->
102+
## Getting Started
103+
104+
### Installation
105+
106+
1. Clone the repo
107+
```sh
108+
git clone https://github.com/cuappdev/hustle-android.git
109+
```
110+
2. Get the secrets.properties variables pinned in the `#hustle-android` slack channel and place them in a secrets.properties file you create in the project's root directory
111+
3. Download the google-services.json file pinned in the `#hustle-android` slack channel and place the file under the app directory
112+
4. Ask for access to the appdev gmail account from the leads and access the Firebase console --> Find the Hustle Project
113+
5. Navigate to Project Settings -> Android, then add your SHA1 fingerprint, which you can find with the following command `./gradlew signingReport`
114+
6. Build and run the project
115+
116+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
117+
118+
119+
120+
<!-- USAGE EXAMPLES -->
121+
## Usage
122+
123+
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
124+
125+
_For more examples, please refer to the [Documentation](https://example.com)_
126+
127+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
128+
129+
130+
131+
<!-- ROADMAP -->
132+
## Roadmap
133+
134+
- [ ] Feature 1
135+
- [ ] Feature 2
136+
- [ ] Feature 3
137+
- [ ] Nested Feature
138+
139+
See the [open issues](https://github.com/cuappdev/hustle-android/issues) for a full list of proposed features (and known issues).
140+
141+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
142+
143+
144+
145+
<!-- CONTRIBUTING -->
146+
## Contributing
147+
148+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
149+
150+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
151+
Don't forget to give the project a star! Thanks again!
152+
153+
1. Fork the Project
154+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
155+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
156+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
157+
5. Open a Pull Request
158+
159+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
160+
161+
### Top contributors:
162+
163+
<a href="https://github.com/cuappdev/hustle-android/graphs/contributors">
164+
<img src="https://contrib.rocks/image?repo=cuappdev/hustle-android" alt="contrib.rocks image" />
165+
</a>
166+
167+
168+
169+
<!-- LICENSE -->
170+
## License
171+
172+
Distributed under the project_license. See `LICENSE.txt` for more information.
173+
174+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
175+
176+
<!-- CONTACT -->
177+
## Contact
178+
179+
- Cornell AppDev - [email protected]
180+
- Andrew Cheung - [email protected]
181+
182+
183+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
184+
185+
186+
187+
<!-- MARKDOWN LINKS & IMAGES -->
188+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
189+
[contributors-shield]: https://img.shields.io/github/contributors/cuappdev/hustle-android.svg?style=for-the-badge
190+
[contributors-url]: https://github.com/cuappdev/hustle-android/graphs/contributors
191+
[forks-shield]: https://img.shields.io/github/forks/cuappdev/hustle-android.svg?style=for-the-badge
192+
[forks-url]: https://github.com/cuappdev/hustle-android/network/members
193+
[stars-shield]: https://img.shields.io/github/stars/cuappdev/hustle-android.svg?style=for-the-badge
194+
[stars-url]: https://github.com/cuappdev/hustle-android/stargazers
195+
[issues-shield]: https://img.shields.io/github/issues/cuappdev/hustle-android.svg?style=for-the-badge
196+
[issues-url]: https://github.com/cuappdev/hustle-android/issues
197+
[license-shield]: https://img.shields.io/github/license/cuappdev/hustle-android.svg?style=for-the-badge
198+
[license-url]: https://github.com/cuappdev/hustle-android/blob/master/LICENSE.txt
199+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
200+
[linkedin-url]: https://linkedin.com/company/cornellappdev
201+
[product-screenshot]: images/screenshot.png
202+
<!-- Shields.io badges. You can a comprehensive list with many more badges at: https://github.com/inttter/md-badges -->
203+
[Kotlin Badge]: https://img.shields.io/badge/Kotlin-7F52FF?logo=kotlin&logoColor=fff&style=for-the-badge
204+
[Jetpack Compose Badge]: https://img.shields.io/badge/Jetpack%20Compose-4285F4?logo=jetpackcompose&logoColor=fff&style=for-the-badge
205+
[Firebase Badge]: https://img.shields.io/badge/Firebase-DD2C00?logo=firebase&logoColor=fff&style=for-the-badge
206+

0 commit comments

Comments
 (0)