jameschenn / PokeFlex

PokéFlex is a social cataloging application website utilizing a list-like system to help trainers from different regions of the world organize and review Pokémon to help them catch ‘em all!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PokéFlex

Welcome to the PokéFlex wiki page! PokéFlex, a Goodreads clone, is a social cataloging application website utilizing a list-like system to help trainers from different regions of the world organize and review Pokémon to help them catch ‘em all!

Live Site Link

PokéFlex

Link to Wiki Docs

Home

API Documentation

Database Schema

Feature List

Frontend Routes

User Stories

Project Team

This project is designed by James Chen, Grant Walton, Khoi Duong, and Dayton Chen

Techonology Used

JavaScript HTML5 CSS3 Pug NodeJS Postgres Sequelize Express.js Visual Studio Code Git

Getting Started

  1. Clone this repistory

    https://github.com/jameschenn/PokeFlex.git

  2. Install the project's dependencies

    npm install

  3. Add an .env file containing the variables from the .env.example file

  4. Create user and database based on what you setup in .env file

  5. Use the Sequelize CLI to apply the provided database migrations and seeder.

    npx dotenv sequelize db:migrate

    npx dotenv sequelize db:seed:all

  6. You can now test the application

    npm start

  7. You can sign in via Demo User or create an account yourself

Features

  1. Trainer Authentication
  • Trainers can sign up, log in, and log out.
  • Trainers can use a demo log in to try the site.
  • Trainers can't rate, write reviews, nor add/remove pokemons from catchlists without logging in.
  • Logged in trainers are directed to their profile page.
  • Logged out trainers are directed to the homepage.
  1. Pokemon
  • All trainers can view a list of pokemons. pokeflex github2

  • If a trainer clicks on a pokemon link, the trainer is redirected to the pokemon's page, and the trainer can see information and reviews/ratings about that pokemon. pokeflex github5

  1. Catchlists
  • Logged in trainers has a personal list of pokemons
  • There are 3 separate lists in the catchlist (need to catch, caught, plan to catch)
  • Logged in trainers can add additional, personalized catchlists for more personal needs
  • Logged in trainers can add or remove pokemon to one of the three catchlists
  • Logged in trainers can change the catch status of the pokemon pokeflex github3 pokeflex github1
  1. Search
  • All trainers can search Pokemon by name using the search bar pokeflex github4

About

PokéFlex is a social cataloging application website utilizing a list-like system to help trainers from different regions of the world organize and review Pokémon to help them catch ‘em all!


Languages

Language:JavaScript 66.3%Language:Pug 21.1%Language:CSS 12.6%