Giter VIP home page Giter VIP logo

dogspedia's Introduction

Dogspedia - SPA

Logo

Single Page application for the all dog lovers out there.

Builded using the PERN stack, and the dogs api.

Features

  • See up to 8 dog breeds in a single page as cards with their name, image, and temperament.
  • Pagination
  • See the detail of a certain breed by clicking the image, where you can see the image, name, height and weight (in cm), life span, and temperaments.
  • Filter the breeds by temperament and if they were created or not.
  • Sort them by name ascendent and descendent, and by weight from lightest no heaviest and vice versa.
  • Search for breeds that contain the searched term.
  • Create your own breed.

Tech Stack

Front-end: React, Redux.

Back-end: Node, Express, and PostgreSQL for the database.

How to Run Locally

To run this project, first you will need to add the following environment variables to your .env file.

API_KEY - which you will get by creating an account on the dogs api.

DB_USER - your database username.

DB_PASSWORD - your database password.

DB_HOST- the host where your database is located.

DB_NAME- the name of your database.

DB_PORT - the port from where your database is listening.

API_PORT - the port from where your api is listening

NODE_ENV - the Server current environment for good connection with the client

CLIENT_DEV_URL - the client dev url for CORS config

CLIENT_PROD_URL - the client production url for CORS config

NOTE: You can also check the .env.example file to see envs example values.

The import and use of these environment variables is already done by the app

Then, follow the steps below:


Clone the project

git clone https://github.com/NachoHotz/Dogspedia.git

Go to the project directory

cd Dogspedia

Head to the api folder

cd api

Install dependencies

npm install

Do the same but with the client folder

cd client
npm install

Then, execute npm start on both folders to initialize the database, and the client to run the app.

Screenshots

This project is being updated

dogspedia's People

Contributors

nachohotz avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.