Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomasevano committed Feb 14, 2021
1 parent 68c23dc commit 52fb48c
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# sneakers-vue-nuxt
# 👟 Sneakers Collection

**⚠️ Still a work in progress**

## What is it?

Sneakers collection is a simple Vue.js (powered by [Nuxt.js](https://nuxtjs.org)) open-source web app where you can see the next 10 sneakers releases of the most known sneakers brands ( Nike, Adidas, Puma, New Balance ...) in just a second on the home page. You can find sneakers by searching with the name, the brand, gender, the released year and even the exact released date.
All of these sneakers data are provided by the wonderful API of [The Sneakers Database](https://thesneakerdatabase.com/).

## Why?

As a series addict [TV Time](https://www.tvtime.com/) changed my life when it comes to knowing when a new seasons/episodes of my favourite shows are coming out and when I wanted to know what show I have already seen.
As a sneaker addict, I wanted to make the same thing for sneakers. With all the new releases every week it's not that easy to know what is coming out and when. So I wanted to know in a single place what is released and when. Make lists of my most wanted/favourite sneakers, know where I can buy at resell and at what estimated price, and see what is the **Sneakers Collection** of other sneakers passionate like me.

## Next Features

- A homemade GraphQL API.

- Basic authentication (Username + Password).
- SSO authentication (Connect with Apple, Twitter, Google).
- Create lists of sneakers (Favourite, Wanted, Owned etc).
- See profile with lists of other users.
- Make your profile public or private.

- A much better UX/UI (I'm not very good at this, would love some help).

## Build Setup

Expand All @@ -16,5 +40,3 @@ $ yarn start
# generate static project
$ yarn generate
```

For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).

0 comments on commit 52fb48c

Please sign in to comment.