Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BrianCheung1 authored Oct 20, 2023
1 parent 1055900 commit 27480bd
Showing 1 changed file with 34 additions and 23 deletions.
57 changes: 34 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,47 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# Jesflix

## Getting Started
## Demo link:
Access my site at [PokeData](https://pokedata-rose.vercel.app/)

First, run the development server:
## Table of Content:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
- [About The App](#about-the-app)
- [Screenshots](#screenshots)
- [Technologies](#technologies)
- [Setup](#setup)
- [Status](#status)

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## About The App
Pokedata offers easy access to pokemon stats, counters, moves and images. Provides up to date events with countdown to allow users to see exactly what events are happening and when they will start/end.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## Screenshots
![Home/Search Page](https://i.imgur.com/cudpiUT.png)
![Pokedex](https://i.imgur.com/0u1GFUd.png)
![Team Rocket Go](https://i.imgur.com/2p71ane.png)
![Events](https://i.imgur.com/cxY4JOG.png)
![Raids](https://i.imgur.com/z9FUl6G.png)

## Learn More

To learn more about Next.js, take a look at the following resources:
## Technologies
Nextjs, React, Tailwind, Mantine Dev, Vercel, Github

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
## Third Party APIs
[Pogoapi.net](https://pogoapi.net/)
[Pokeapi.co](https://pokeapi.co/)
[ScrapedDuck](https://github.com/bigfoott/ScrapedDuck)
[LeekDuck](https://leekduck.com/)
[PogoInfo](https://github.com/ccev/pogoinfo)

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Setup
- download or clone the repository

- run `npm install`
- run `npm run dev`
- Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Status
PokeData is mostly complete but missing some information such as up to date raids and newly released pokemons

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

0 comments on commit 27480bd

Please sign in to comment.