Skip to content

Commit 452f183

Browse files
authored
docs: Add image badges to README for tech stack and repo details
1 parent 6534162 commit 452f183

File tree

1 file changed

+46
-4
lines changed

1 file changed

+46
-4
lines changed

README.md

+46-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
# GearUP - Project README
2-
# Back-End
1+
[![GitHub contributors](https://img.shields.io/github/contributors/gearup-2305/gearUp-BE)](https://github.com/gearup-2305/gearUp-BE/graphs/contributors)
2+
[![GitHub forks](https://img.shields.io/github/forks/gearup-2305/gearUp-BE)](https://github.com/gearup-2305/gearUp-BE/forks)
3+
[![GitHub Repo stars](https://img.shields.io/github/stars/gearup-2305/gearUp-BE)](https://github.com/gearup-2305/gearUp-BE/stargazers)
4+
[![GitHub issues](https://img.shields.io/github/issues/gearup-2305/gearUp-BE)](https://github.com/gearup-2305/gearUp-BE/issues)
5+
6+
# GearUp (Back-End Repo)
37

48
Link to [GearUP Website]()
59
Link to [Front-End Repo]()
@@ -22,6 +26,16 @@ Link to [Front-End Repo]()
2226
- ShouldaMatchers gem for testing assertions
2327
- VCR / Webmock to stub HTTP requests in tests to simulate API interactions
2428

29+
### Built With
30+
* ![Ruby](https://img.shields.io/badge/ruby-%23CC342D.svg?style=for-the-badge&logo=ruby&logoColor=white)
31+
* ![Postgresql](https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white)
32+
* ![Rails](https://img.shields.io/badge/rails-%23CC0000.svg?style=for-the-badge&logo=ruby-on-rails&logoColor=white)
33+
* ![GraphQL](https://img.shields.io/badge/-GraphQL-E10098?style=for-the-badge&logo=graphql&logoColor=white)
34+
* ![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)
35+
* ![Heroku](https://img.shields.io/badge/heroku-%23430098.svg?style=for-the-badge&logo=heroku&logoColor=white)
36+
* ![Postman Badge](https://img.shields.io/badge/Postman-FF6C37?logo=postman&logoColor=fff&style=for-the-badge)
37+
* ![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
38+
2539
### Project Description
2640
GearUP is a crowd funding app for artists to request supplies they need. It is a full stack SOA application that utilizes GraphQL to communicate between the front and back end. The back end also utilizes Sidekiq and Action Mailer to send confirmation and update emails to its users. There is an option to create an account to add a new post, or donors can search and select a project to donate to without having to create an account.
2741

@@ -35,7 +49,8 @@ The backend app exposes a GraphQL API endpoint with data for performing queries
3549

3650
1. `POST /graphql`
3751

38-
Queries:
52+
**Queries:**<br>
53+
All Artists:
3954
```
4055
query artists {
4156
artists {
@@ -70,7 +85,8 @@ query artists {
7085
}
7186
```
7287

73-
Mutations:
88+
**Mutations:**<br>
89+
Create Post:
7490
```
7591
mutation {
7692
createPost(input:{
@@ -93,6 +109,32 @@ mutation {
93109
}
94110
}
95111
```
112+
113+
Create Donation:
114+
```
115+
mutation UpdatePost {
116+
updatePost(input: {
117+
id: 1
118+
title: "I need "
119+
details: "Don't worry"
120+
imageUrl: "http://wiegand.test/jaye_reinger"
121+
requestedAmount: 3444.00
122+
currentAmount: 0
123+
artistId: 1
124+
}) {
125+
post {
126+
id
127+
title
128+
details
129+
imageUrl
130+
requestedAmount
131+
currentAmount
132+
}
133+
errors
134+
}
135+
}
136+
```
137+
96138
### Future Iterations
97139
1. Add funcionality for payment processing using services such as PayPal, Venmo, Square, and/or Apple Pay
98140
2. Utilize OAuth to create and login to account

0 commit comments

Comments
 (0)