BiteBYTE

Table of Contents

• Introduction
• Features
• Technologies Used
• Installation
• Screenshots
• Contributing
• Contact

Introduction

This project is a full-stack web application built using the PERN stack (PostgreSQL, Express.js, React, and Node.js). It demonstrates the fundamental CRUD (Create, Read, Update, Delete) operations, providing a comprehensive example of how these operations can be implemented in a modern web application.

Purpose

The purpose of this project is to serve as a learning tool and a reference for developers who want to understand how to build and integrate a full-stack application using the PERN stack. It showcases the best practices for setting up a backend server with Express.js and Node.js, managing a PostgreSQL database, and creating a dynamic front-end interface with React.

Features

• Create, Read, Update, Delete (CRUD) operations
• RESTful API
• Responsive Design

Technologies Used

• PostgreSQL: Database
• Express.js: Back-end Framework
• React: Front-end Framework
• Node.js: Server Environment

Installation

Prerequisites

• Node.js
• npm
• PostgreSQL

Clone the Repository

git clone https://github.com/KhylaRedd/bitebyte-FE.git
cd your-repo-name

Backend Setup

Deployed Backend URL - https://bitebyte-backend-rjw6.onrender.com/

Backend Repository - https://github.com/Nadi-BrooklynCoder/BiteByte-Backend

Deployed Frontend URL - https://bitebytes.netlify.app/

1. Install dependencies

npm install

2. Create a .env file and add your environment variables

PORT=your-port-number
PG_HOST=localhost
PG_PORT=5432
PG_DATABASE=your-database-name
PG_USER=postgres

3. Run database migrations and seed data

npm run db:init
npm run db:seed

4. Start the server

npm start

Frontend Setup

1. Install dependencies

npm install

2. Start the server

npm start

Contributing

We welcome contributions to this project! Here’s how you can help:

How to Contribute

1. Fork the Repository

   • Click the "Fork" button at the top-right of the repository page to create your own copy of the project.

2. Clone Your Fork

   • Clone your forked repository to your local machine:

     git clone https://github.com/KhylaRedd/bitebyte-FE.git

3. Create a New Branch

   • Create a new branch for your changes:

     git checkout -b your-feature-branch

4. Make Your Changes

   • Make your changes to the codebase.

5. Commit Your Changes

   • Add and commit your changes with a descriptive message:

     git add .
     git commit -m "Add a meaningful commit message"

6. Push to Your Fork

   • Push your changes to your forked repository:

     git push origin your-feature-branch

7. Create a Pull Request

   • Go to the original repository and create a pull request from your forked repository. Provide a clear description of the changes you made and why they are needed.

Pull Request Guidelines

• Describe Your Changes: Clearly explain what changes you’ve made and why they are necessary.
• Keep It Focused: Ensure your pull request addresses a single main change. If you have multiple unrelated changes, consider creating separate pull requests for each.
• Follow the Code Style: Adhere to the project's coding conventions and style guide to maintain consistency.
• Update Documentation: If your changes affect the documentation, make sure to update it to reflect the new state of the project.
• Test Your Changes: Ensure that your changes are well-tested and do not break any existing functionality.

Thank you for contributing!

Contact Creators

• LinkedIn: Nadia Matos | Khyla Redd | Diamond Brown