Skip to content

Jade-Jones-dev/hot-sauce

Repository files navigation

Hot Sauce

Hot Sauce is a blazingly hot and spicy web application that allows users to share and discover the spiciest content on the internet. Hot Sauce is the place to heat things up! This repository contains the source code for the Hot Sauce web application.

Table of Contents

Features

Hot Sauce comes with a range of spicy features:

  1. User Authentication: Users can sign up, log in, and manage their spicy content.

  2. Content Upload: Users can upload their spiciest content.

  3. Spice Rating: Users can rate the spiciness of the content they consume, adding a sense of heat to the platform.

  4. User Interactions: Users can like, comment, and share their favorite spicy posts.

Getting Started

To run the Hot Sauce application locally or deploy it on your server, follow the instructions below.

Prerequisites

  • Node.js and npm installed on your system.
  • MongoDB installed and running.

Installation

  1. Clone the repository:

    git clone /~https://github.com/Jade-Jones-dev/hot-sauce.git
    cd hot-sauce
  2. Install the dependencies:

    npm install
  3. Create a .env file in the root directory and set the following environment variables:

    MONGODB_URI=<your_mongodb_connection_string>
    JWT_SECRET=<your_jwt_secret_key>
    
  4. Run the development server:

    npm run dev
  5. The application should now be running locally at http://localhost:3000.

Usage

Once the Hot Sauce application is up and running, users can visit the website, sign up, and start sharing and exploring spicy content. They can interact with other users, rate content, and help decide what's the hottest content on the platform.

Contributing

We welcome contributions to make Hot Sauce even spicier! If you want to contribute, please follow these steps:

  1. Fork the repository.

  2. Create a new branch for your feature or bug fix:

    git checkout -b my-feature
  3. Make your changes and commit them:

    git commit -m "Added a new feature: spicy feature"
  4. Push the changes to your forked repository:

    git push origin my-feature
  5. Open a pull request on the main branch of the original repository.

We will review your pull request and merge it if everything looks good.

License

Hot Sauce is released under the MIT License. Feel free to use, modify, and distribute this code as per the terms of the license.


We hope you enjoy using Hot Sauce as much as we enjoyed creating it. If you have any questions or need assistance, feel free to contact us or open an issue in the repository.

Spice it up! 🌶️

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published