lewisblackburn / petal

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Petal

Petal Logo

Petal is a comprehensive database that brings together information about films, TV shows, books, people, and songs, all in one convenient platform. Just like popular services like TMDB or IMDb, Petal provides a place for users to navigate, create and update their favourite media.

Features

  • Search and Recommendations: Use powerful search capabilities to find specific titles or explore personalized recommendations based on your interests.

  • User Reviews and Ratings: Contribute to the community by leaving your own reviews and ratings for your favorite media content.

Installation and Usage

Prerequisites

Before running Petal, ensure you have the following dependencies installed:

  • Node.js
  • Fly

Installation

Follow these steps to set up and run Petal:

  1. Clone the repository:
git clone https://github.com/lewisblackburn/petal.git
cd petal
  1. Install the required packages:
npm install
  1. Set up the database:
npm run setup
  1. Open your web browser and visit http://localhost:3000 to access Petal.

Demo

For a live demo of Petal, you can visit petal.fly.dev.

Contributing

We welcome contributions to improve Petal! To contribute, please follow the guidelines outlined in CONTRIBUTING.md.

Support

For any issues, bug reports, or feature requests, please open a new GitHub issue.

Acknowledgments

This project is built upon The Epic Stack 🚀 boilerplate by Kent C. Dodds and contributors. Special thanks to their valuable work and contribution to the community.

License

This project is licensed under the MIT License which applies to "The Epic Stack 🚀" boilerplate as well.

Last Sync

https://github.com/epicweb-dev/epic-stack/commits/05d92de7e0ebd580edbf4bdd6b43447b32ece5e7/

About


Languages

Language:TypeScript 99.1%Language:JavaScript 0.5%Language:Dockerfile 0.3%Language:CSS 0.2%