Pawfect Events API

Table of Contents

1. Project Overview
2. Installation & Setup

Project Overview

This is the backend for the Pawfect Events Web App, and is a fully functional restful API. It utilises full CRUD functionality as well as queries to provide lots of different functionality for the frontend to leverage in order to create a seamless and dynamic experience for users.

The live version of the API is hosted using the cloud application hosting service, Render and the database hosting service, Supabase.

This version can be found here.

Note that it may take up to a couple of minutes to spin up the server.

Installation & Setup

Minimum Installation Requirements

• Node.js - Version v21.2.0
• PostgreSQL - Version 14.9

Installation Walkthrough

1. Start by forking the project repository, and open up a terminal. Then do the following steps:

   1A. Clone the repository to your local machine

   git clone https://github.com/Iagrah99/pawfect-events-api.git

   2B. Change from the current directory into the project folder

   cd pawfect-events-api

   3C. Open up the folder in VS Code

   code .

2. Now let's verify you have both Node & PostgreSQL installed. Inside VSCode open a terminal window CTRL/CMD SHIFT `. Then do the following steps:

   2A. Run the check version command for Node

     node --version
   

   2B. Run the check version command for PostgreSQL

     psql --version
   

   2C. Once both versions are verified, we can install our dependencies by running the following Node Package Manager (NPM) command:

     npm install
   

How To Get Started Running The Project

Create The Environment Variables

Once you have successfully followed the installation steps, you will need to create the following .env files yourself inside of the root folder:

.env.test and .env.development

Inside both of these files you will have to specify which database you want to connect to. Inside the .env.test file you will need to write the following code:

PGDATABASE=dog_events_test

Inside the .env.development file you will need to write:

PGDATABASE=dog_events

Ensure that the names of both files are present inside of your .gitignore file. If it's not already there, you can simply write .env.* on a new line and it will target both .env files.

Seeding The Database

Before you are able to use or test the application, you will need to set up the database and seed it with the data. In the terminal, enter the following commands:

npm run setup-dbs

npm run seed

Both of these commands reference NPM scripts found within the package.json file. Now you should be good to go either running or testing the API. Note that the database will be automatically reseeded prior to each test, so you will not need to run these commands again.

API Testing

To run a test, type in the following command:

npm test

This will run every test file within the project files, which in our case only includes the app.test.js file. In the event that other test files exist, we can simply append the app.test.js file name to the npm test command to specifically test our server endpoints.

To run specific test suites, prefix them with .only, for example:

describe.only() => {
...
}

If you wish to see a full list of all the endpoints, checkout the endpoints.json file.