search

Pets-without-names / Jax-Pet-Names

This project is a collaboration designed to create a pet naming web application.
MIT License
3 stars 2 forks source link

readme

Overview:

"Jax Pet Names" started with a lone volunteer at the Humane Society who identified the complexities faced by the organization when a dog with a cool name was adopted. That name, which would have previously been a duplicate (and there for not allowed as a name by the system), was now available to be assigned to an incoming pet. Wahoo!

Thinking up a good name for a pet at the shelter that was not a duplicate turned out to be a time consuming process. Sure, there are other pet naming tools out there. But why don't I make one myself? This brave soul asked into the universe! Next, forming a brainstorm at a local meetup a council was formed and this project began to churn into what you see today.

Primarily our planning is located: here: (To Be Revealed, probably github issues or github project board.)

regards, woof woof meow.

Cypress test suite usage:

  1. If the front end and backend are not running: npm install; npm run app:cypress;
  2. If the front end and backend are running: npm install; npm run cypress;

Backend Details,

sourced from the readme: here # Pet Names Server ### Requirements - Node.js (18.15.0 or higher) - Postgres (14.7 or higher) ### Local Setup **Note**: Skip this section if running docker compose on the entire app. 1. Clone project: `git clone git@github.com:JaxTurboNerd/Jax-Pet-Names.git` 2. Navigate into server folder: `cd Jax-Pet-Names/server` 3. Add .env file for your database URLs. Set variables: - `DB_URL`: Connection URL to postgres server **including database**. (Example: `postgresql://username:password@host:port/database`) - `DB_SETUP_URL`: URL to postgres server only. (Example: `postgresql://username:password@host:port`) 4. Install dependencies: `npm install` 5. Install `knex` globally: `npm install knex -g` 6. Setup database with tables and test data: `npm run db:setup` 7. Start the server: `node index.js` ### Docker (Database only) **Note**: Skip this section if running docker compose on the entire app. To avoid configuring Postgres locally, you can setup a Postgres container with Docker. 1. Ensure Docker is installed. See [Docker Engine docs](https://docs.docker.com/engine/install/) for installation instructions. 2. Close any current Postgres processes. MacOS: `brew services stop postgresql`, Ubuntu/Debian: `sudo systemctl stop postgresql` 3. Configure .env file for your database URLs. Set the URLs to these values: - `DB_URL`: `postgresql://postgres:postgres@localhost:5432/pet_names` - `DB_SETUP_URL`: `postgresql://postgres:postgres@localhost:5432` 4. Run command to setup Postgres container: `sudo docker run -p 5432:5432 --name jax-pet-names-pg -e POSTGRES_PASSWORD=postgres -d postgres` ### Database Scripts - Create Database: `npm run db:create` - Drop Database: `npm run db:drop` - Migrate Database: `npm run db:migrate` - Seed Database: `npm run db:seed` - Reset Database (without seed): `npm run db:reset` - Reset Database (with seed): `npm run db:setup` - Production Database Setup: `npm run db:production:setup` ### Current APIs - `GET /names` - `POST /names` - `GET /names/:id` - `PUT /names/:id` - `DELETE /names/:id`

Front End Details,

sourced from the readme: here # Pet Names Web App This web app will allow the user to simply click a button and a randomly generated pet name will show. The user can chose between a male or female name. ## Requirements - Node.js - React ### Local Setup **Note**: Skip this section if running docker compose on the entire app. 1. Clone project: `git clone git@github.com:JaxTurboNerd/Jax-Pet-Names.git` 2. Navigate into folder: `cd Jax-Pet-Names/client` 3. Add `.env` file with `REACT_APP_HOST` set to your host URL. This will be `http://localhost:3001` when using the local backend server. 4. Install dependencies: `npm install` 6. Start just front end: `npm run start` 7. Usually you need the backend running locally along with the front end. To start both at the same time, navigate to the root folder (`cd ..`) and run: `npm run app:start`

Docker

This app can optionally be run entirely in Docker. This can be used to avoid setting up Node and Postgres locally.

  1. Ensure Docker is installed. See Docker Engine docs for installation instructions.
  2. Run docker compose build. This builds the images for frontend and backend servers.
  3. Run docker compose up. This starts the containers for the servers.
  4. Run the script to setup the database tables and seed data: docker exec -it jax-pet-names-server npm run db:setup
  5. The app is now running.

App Scripts