Skip to content

Commit

Permalink
docs: updated instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
qwrtsdev committed Oct 23, 2024
1 parent bbadc44 commit 49d8a3b
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 4 deletions.
15 changes: 15 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: qwrts
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
polar: # Replace with a single Polar username
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
thanks_dev: # Replace with a single thanks.dev username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,32 @@

![Swipify Logo](https://media.discordapp.net/attachments/1297492873398452267/1298371333851185253/swipify-githublogo.png?ex=67195208&is=67180088&hm=81c8044cbfbd41b93b3c651dfd0d2cca07c322730fa730bce6fe0ecf6444f1ad&=&format=webp&quality=lossless&width=994&height=285)

![Discord](https://img.shields.io/discord/1236751677801889792?style=flat&logo=discord&labelColor=blueple&color=%235865F2&link=https%3A%2F%2Fdiscord.gg%2FJKsYSd4TVf) ![GitHub last commit](https://img.shields.io/github/last-commit/qwrtsdev/swipify-react) ![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/dumbqwrts)
![Discord](https://img.shields.io/discord/1236751677801889792?style=flat&logo=discord&labelColor=blueple&color=%235865F2&link=https%3A%2F%2Fdiscord.gg%2FJKsYSd4TVf) ![GitHub last commit](https://img.shields.io/github/last-commit/qwrtsdev/swipify-react) ![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/dumbqwrts)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/W7W712L0CA)


**Swipify** is an open-source music shuffler.<br />
based on [Tinder](https://tinder.com) and [Swipefy](https://x.com/swipefyapp) but made completely from scratch!<br />
inspried from [Tinder](https://tinder.com) and [Swipefy](https://x.com/swipefyapp) but made completely from scratch!<br />
for people who feeling bored with their every day song.

</div>

> [!NOTE]
> This project was my first web application for educational and made during rush, thus it was not taking serious like it should do. You might find it wacky and facing some issues during use.
> [!NOTE]
> This project is now planned to be **continue** in the future, please stay tuned for any further updates.
## 📝 Prequisites
- [Spotify Developer Account](https://developer.spotify.com/)
- [Google Firebase Account]()

## ⚙ Setup
> [!CAUTION]
> For beginners: please don't skip and follow the instructions carefully to making sure nothing is broken. (sorry for the inconvenience.)
- Go to [Spotify API Dashboard](https://developer.spotify.com/dashboard/) and create the application
- Run `yarn add` in project's terminal to install all the dependencies
- Go to [Spotify API Dashboard](https://developer.spotify.com/dashboard/) and create an application
- Go to application's settings and copy `Client ID` and `Client Secret`
- Create an `.env` file and enter
```
Expand Down Expand Up @@ -54,7 +60,7 @@ for people who feeling bored with their every day song.
VITE_FB_APPID=""
VITE_FB_MID=""
```
(Some keys just not necessary to use but keep them as they might help. Read full documentation about Firebase Authentication [here](https://firebase.google.com/docs/auth))
- Fill out all the keys to enable the Authentication (Some keys just not necessary to use but keep them as they might help. Read full documentation about Firebase Authentication [here](https://firebase.google.com/docs/auth) / You can remove the authentication processes from the system. If you know how.)
## 💬 Community
The **FullstackHub** community is very welcomed for everyone! Where you can ask questions, sharing knowledges and ideas about web development or programming-related topics.<br />
Expand Down

0 comments on commit 49d8a3b

Please sign in to comment.