Skip to content

rojikaru/ponzu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ponzu

Ponzu is an anime and manga library application that allows users to rate, comment on, and share fan content for their favorite series.

Features

  • Comprehensive anime and manga database
  • User ratings and reviews
  • Fan content sharing (fanart, fanfiction, etc.)
  • Personalized recommendations
  • Social features for connecting with other fans

Tech Stack

  • Backend: Actix Web (Rust)
  • Database: MongoDB
  • Frontend: Next.js
  • State Management: Jotai
  • Styling: Tailwind CSS
  • API: Jikan API
  • Deployment: Heroku

Prerequisites

  • Cargo
  • Node.js 20+
  • MongoDB

Installation

  1. Clone the repository:

    git clone https://github.com/rojikaru/ponzu.git
    cd ponzu
    
  2. Set up the backend:

    cd ponzu-back
    cargo run
    
  3. Set up the frontend:

    cd ponzu-front
    npm install
    
  4. Configure the environment variables:

    • Create a .env file in both the backend and frontend directories
    • Add necessary environment variables (database connection, API keys, etc.)

Running the Application

  1. Start the Django backend:

    cd ponzu-back
    cargo run
    
  2. In a new terminal, start the Next.js frontend:

    cd ponzu-front
    npm run dev
    
  3. Access the application at http://localhost:3000 (and backend at port 8000)

Contributing

We welcome contributions to Ponzu! Please read our Contributing Guide for more information on how to get started.

License

This project is licensed under the MIT License.

Contact

For any questions or concerns, please open an issue on this repository or contact the maintainers at emails provided in contributors' profiles.


Happy coding, and may your favorite series always be top-ranked! 🌟

Pythor