woof

A Bootcamp challenge. TheDogApi wrapper, with custom API and Client. We just had 2 weeks to finish it and we couldn't use any technologies that have not been mentioned.

This project is just an initial release, so can be updated in a future with new features.

Client is a React app, with React Router and Redux. API uses Express, Sequelize and PostgreSQL as DB.

Screenshots

Homepage

Breeds list

Filtering

Sort and filter at same time

Searching

Breed details

Creating a new breed

Getting started

Database and .env files setup

Firstly, you must create a postgresql database. Then go api folder and client folder, rename .example.env file to .env, and then fill in the database credentials.

Running locally in development mode

To get started, just clone the repository and run npm install and npm start.:

git clone https://github.com/facuparedes/woof.git

cd ./api
npm install
npm start

cd ../client
npm install
npm start

Note: If you are running on Windows and you have issues with fsevents, run install --noptional flag (i.e. npm install --no-optional) which will skip installing fsevents.

Building and deploying in production

If you wanted to run this site in production, you should install modules then build the site with npm run build and run it with serve:

Linux & MacOS

cd ./client
npm install
npm run build

npm install -g serve
serve -s build

Windows

cd ./client
npm install
npm run build

npm install -g serve
serve -s build

Note: You should run npm run build again any time you make changes to the site.

Todo

• Homepage
• List breeds
  • Filter breeds
  • Sort breeds
  • Search breeds
  • Show breed's temperaments
• Show breed's details
• Create breeds
  • Custom images
• Edit breeds
• Delete breeds