Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 1.24 KB

README.md

File metadata and controls

50 lines (39 loc) · 1.24 KB
Raw

Animal Kingdom Database

A web app allows users to search about animals and learn more about their classifications such as phylum, class, order, and more.

Stack

  • Next.js - Full-Stack
  • Tailwind - Utility CSS framework
  • Shadcn - Components using Tailwind CSS
  • PostgreSQL - SQL Database
  • Prisma - ORM
  • GraphQL - API
  • TypeScript - Programming language

Setting Up Locally

Prerequisites

  • Postgresql 16+
  • Node.js 18

First, clone this repository Then, you can open the terminal on your machine and navigate to the cloned repo's root directory. Next, make a .env.local file from the .env.example file and fill in the variables in the new .env.local file Now, run this command

  npm install
  or
  yarn install
  or
  pnpm install

Finally, you can run the project by using the command:

npm run dev
or
yarn run dev
or
pnpm run dev

Contributing

Contributions to this repository are most welcome. To get started, please read the guide here: Contributing

If you have any questions, feel free to reach out to me at karellehofler@outlook.com or DM me on Twitter/X @itskarelleh.